diff --git a/README.md b/README.md index 5487d49..3b98972 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ -pppadindex +__pppadindex__ + +Generates templated publications based on [pppadump](https://git.le-club-des-sans-sujets.org/Le-Club-des-Sans-Sujets/pppadump) + +__requirements__ + +* python3 / pip3 + +__installation__ + + $> . setenv + +The program will check your python3 environment and interactively asks some questions (if need is): + + venv DOES NOT exists... + Setup venv? [y/N]> y + Creating python3 venv + Done. + +The program will also check wether pppadum is install or not and interactively asks some questions (if need is): + + pppadump IS NOT installed + pip install pppadump? [y/N]> y + Pip installing pppadump + Done. + +When the environment is set, initialise the project with: + + $> make init + +The program then interactively asks some questions: + + Please type the URL of the etherpad: + http://automatist.local:9001/ + The APIKEY is the contents of the file APIKEY.txt in the etherpad folder + Please paste the APIKEY: + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + +__usage__ + + $> . setenv + $> make pull + $> make index -pppad index for generating publications based on pppadump \ No newline at end of file