This repository was archived by the owner on Jan 2, 2020. It is now read-only.
This repository was archived by the owner on Jan 2, 2020. It is now read-only.
Add user manual #4
Open
Description
A user manual is required, explaining how to:
- download (which version Implement versioning #2 etc.)
- compile (software dependencies, configuration options etc.)
- install (user permissions, options etc.)
- configure (logging etc.)
- run (config file, enviroment variables etc.)
- use as a library from Python, C, Cython etc. (Add usage examples #3)
The manual should also mention that q3py
is targeted at developers, not gamers or server admins.
The manual should be part of the README
, the documentation and possibly in a GitHub wiki page as well.