43d162f452
This documents/should document: * what the signatures are and what they proof * how to verify them * how to build releases (I know more of a maintainer doc, but yeah, I found it a good place here, if you want a separate one feel free) This should also make it easier for other maintainers to create releases or so. @elrido feel free to adjust/push to the branch if you want to have some details fixed. I have left some TODOs of stuff where I am unsure. |
||
|---|---|---|
| .. | ||
| Generating Source Code Documentation.md | ||
| Installation.md | ||
| README.md | ||
| Release.md | ||
| Running Unit Tests.md | ||
PrivateBin Documentation
Frequently Asked Questions
Please have a look at these questions before opening an issue in this repo.
Installation guide
Minimal requirements, hardening and securing your installation and initial configuration.
Configuration guide
Detailed guide on each configuration option and their effects.
Templates
How to change an existing template or create your own, as well as an overview of the currently included templates.
Translation guide
How to help translate PrivateBin and technical background on it's implementation.
Developer guide
Know how for participating in PrivateBins development.
Generating Source Code Documentation
How to generate the source code API documentation, as found on the project website for PHP and JS
[Running Unit Tests](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Running Unit Tests.md#running-all-unit-tests)
How to run the PHP & JS unit tests, including a brief introduction to property based unit testing.