New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create reasonably minimum amount of documentation #3

Open

boamaod opened this issue Mar 7, 2022 · 1 comment

Milestone

Contributor

boamaod commented Mar 7, 2022

The minimal documentation should probably explain:

The basic rationale, scope and uses for the project;
Using the example web service (explain the configuration properties);
Cautions/instructions for running in practise (real elections, hacking contests etc);
Running your own instance and modifying the code.

This should be more than enough for the code release... Wiki, readme or something else?

boamaod added this to the Source release milestone

Contributor Author

boamaod commented Feb 23, 2023

There is now documentation served from /docs at:

https://infoaed.github.io/pseudovote/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment