update readme

Author: antheas

README.md

@@ -5,9 +5,12 @@
         <img alt="Pasteur Logo with text. Tagline reads: 'Sanitize Your Data'" src="./res/logo/logo_text_light.svg" width="90%">
     </picture>
 </h1>
-
-Pasteur is a system for data synthesis.
-This readme is under construction.
+Pasteur is a library for performing end-to-end data synthesis.
+Gather your raw data and preprocess, synthesize, and evaluate it within a single
+project.
+Use the tools you're familiar with: numpy, pandas, scikit-learn, scipy or any other.
+When your dataset grows, scale to out-of-core data by using Pasteur's parallelization 
+and partitioning primitives, without code changes or using different libraries.
 
 ## Reproducibility
 You can find the experiment files that can be used to reproduce the paper
@@ -30,4 +33,34 @@ PASTEUR_MODULES = get_recommended_modules()
 Currently, there does not exist a template project from which to start upon.
 This repository is a working Pasteur project and is what was used to develop it.
 The module `./src/project` is a kedro project with configs in `./conf` and it is 
-the one that was used to develop pasteur.
+the one that was used to develop pasteur.
+
+## Contributing
+To contribute, clone this repository and install the frozen requirements.
+```bash
+git clone github.com/pasteur-dev/pasteur pasteur
+
+cd pasteur
+python3.11 -m venv venv
+pip install -r requirements.txt
+```
+
+The requirements file installs Pasteur from this repository in an editable
+state, so you can begin modifying files.
+The requirements file can be regenerated with the following commands, which
+will pull the latest version of packages.
+To ensure interoperability with other packages, Pasteur does not specify narrow
+ranges for supported package versions, which might cause issues for certain version
+combinations.
+```bash
+rm requirements.txt
+pip-compile --resolver=backtracking
+```
+
+This repository is a Pasteur project used for testing. 
+You can start testing Pasteur by running commands.
+```bash
+pasteur download --accept adult
+pasteur p adult.ingest
+pasteur p tab_adult.privbayes --synth
+```