Skip to content
This repository has been archived by the owner on Jan 2, 2020. It is now read-only.

Add user manual #4

Open
2 of 6 tasks
robo9k opened this issue May 25, 2014 · 1 comment
Open
2 of 6 tasks

Add user manual #4

robo9k opened this issue May 25, 2014 · 1 comment

Comments

@robo9k
Copy link
Owner

robo9k commented May 25, 2014

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.

@robo9k robo9k added this to the 1.0.0 milestone May 25, 2014
@robo9k robo9k added the doc label May 25, 2014
robo9k pushed a commit that referenced this issue Jun 1, 2014
@robo9k
Copy link
Owner Author

robo9k commented Jun 21, 2014

Most of those are explained in the documentation, still needs to be expanded somewhat.
No wiki pages were created.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant