-
Notifications
You must be signed in to change notification settings - Fork 85
Home
If you are a user looking for documentation on how to use SC2Reader we have an always in progress user manual hosted by at ReadTheDocs.org.
If you are a developer looking for documentation on the Replay Format itself please see the Replay Format Home page. Please keep in mind that it is not actively maintained any more and that the best source of information is always going to be the source code itself and the people in our community who would be happy to help you through it. If you would like to volunteer to update this section of the site I'd love to have you do it. Put out an email on the mailing list.
If you are a user/developer looking to report a bug, please file it in the github issue tracker and assign it to @GraylinKim initially. He'll take it from there, thanks for the report!
Whew! If you made it this far you must be a looking to contribute to the development of the sc2reader project in some way. We've got features to design, tests to write, marketing to be done, documentation to update, and work for just about anyone who wants it. If you plan on staying a while, please add yourself on our Community page. Its a great way for everyone to see who else is on board with the project and during what times they are likely to be awake and available.
Here's where we would tell you how to get started and point you to some sort of guidelines.
Except we haven't really made any guideline decisions or posted up a whole lot of useful information yet. The wiki will be used for contributor level information and documentation/discussion with all user information getting shipped off to the Sphinx User Manual. That's about all we've decided so far.
Guidelines
- New Wiki pages will be in reStructured text format. We are a python project using Sphinx for the User Manual and its better to be consistent than not. So even if you think markdown is the best and screw all the rest, we'll continue using reStructured text on this wiki. You can use the docutils page as a reference if you need one.
- Old wiki pages in markdown format need to be converted for conformity, except in the ReplayFormat subsection of the wiki since it is no longer being mantained (unless someone wants to volunteer)
That's all for now folks, if you've got ideas about what should go up here...just put it up here. Its easier to ask forgiveness than permission so get started!