Le-Club-des-Sans-Sujets/pppindex
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

READE info

Browse Source
This commit is contained in:
gauthiier 2021-12-10 11:25:38 +01:00
parent 80a375302a
commit 50a95d501a
1 changed files with 43 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -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