about summary refs log tree commit diff
diff options
context:
space:
mode:
authorArun Isaac2025-08-08 15:27:40 +0100
committerArun Isaac2025-08-08 15:27:40 +0100
commitd9c5fa3839d5f065fc9c6d19777766f3fde69741 (patch)
tree2111035c0966fb59efb832ad7f05a5cc9ebf42e5
parent079c09701a10324b265cc8f79642ebdb3293ecf9 (diff)
downloadpyhegp-d9c5fa3839d5f065fc9c6d19777766f3fde69741.tar.gz
pyhegp-d9c5fa3839d5f065fc9c6d19777766f3fde69741.tar.lz
pyhegp-d9c5fa3839d5f065fc9c6d19777766f3fde69741.zip
Add table of contents to README.
A table of contents gives people a brief overview of what's in the
README, and allows them to jump to the section they are interested in.
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index a8aaa2a..79670db 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,16 @@ pyhegp is a Python library and CLI utility implementing homomorphic encryption o
 - [Private Genomes and Public SNPs: Homomorphic Encryption of Genotypes and Phenotypes for Shared Quantitative Genetics](https://academic.oup.com/genetics/article/215/2/359/5930450)
 - [Using encrypted genotypes and phenotypes for collaborative genomic analyses to maintain data confidentiality](https://academic.oup.com/genetics/article/226/3/iyad210/7470728)
 
+- [Install development version](#install-development-version)
+  - [Using pip](#using-pip)
+  - [Using Guix](#using-guix)
+- [How to use](#how-to-use)
+  - [Simple data sharing](#simple-data-sharing)
+  - [Joint/federated analysis with many data owners](#jointfederated-analysis-with-many-data-owners)
+- [File formats](#file-formats)
+- [Run tests](#run-tests)
+- [License](#license)
+
 # Install development version
 ## Using pip
 ### Create a virtual environment (optional)