bitburner-src/README.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

2018-03-27 02:46:21 +02:00
# Bitburner
2018-06-21 16:04:02 +02:00
Bitburner is a cyberpunk hacking-themed incremental game. The game can be
played at https://danielyxie.github.io/bitburner.
2018-03-27 02:46:21 +02:00
# Documentation
2018-06-21 16:04:02 +02:00
The game's official documentation can be found on [Read The
Docs](http://bitburner.readthedocs.io/). Please note that this is still a
work-in-progress and is in its early stages.
2018-03-27 02:46:21 +02:00
2018-06-21 16:04:02 +02:00
The documentation is created using [Sphinx](http://www.sphinx-doc.org).
2018-03-27 02:46:21 +02:00
2018-06-21 16:04:02 +02:00
Anyone is welcome to contribute to the documentation by editing the [source
files](/doc/source) and then making a pull request with your contributions.
For further guidance, please refer to the "As A Documentor" section of
[CONTRIBUTING](CONTRIBUTING.md).
2018-03-27 02:46:21 +02:00
# Wiki
2018-06-21 16:04:02 +02:00
The game's wiki can be found on [Wikia](http://bitburner.wikia.com/). Please
note that the wiki is in the process of being deprecated. Eventually all of
the wiki content will be moved into the Read The Docs documentation.
2018-03-27 02:46:21 +02:00
2018-06-21 16:04:02 +02:00
# Contribution
There are many ways to contribute to the game. It can be as simple as fixing
a typo
If you would like to make any small change or addition to the game, you may
go ahead and do so by submitting a pull request. For guidance on doing so,
please refer to the [CONTRIBUTING](CONTRIBUTING.md) document in this
repository.
2018-03-27 02:46:21 +02:00
You will retain all ownership of the Copyright of any contributions you make,
and will have the same rights to use or license your contributions. By
2018-06-21 16:04:02 +02:00
submitting a pull request you agree to grant me perpetual, worldwide,
non-exclusive, transferable, royalty-free, and irrevocable rights to use,
publish, and distribute your contributions to the project. A formal
Contributor's License Agreement will be drawn up in the future.
2018-03-27 02:46:21 +02:00
If you would like to make significant contributions to the project as a
2018-06-21 16:04:02 +02:00
collaborator, please reach out to @danielyxie to help coordinate the effort.