mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-08 08:43:53 +01:00
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
|
# Bitburner
|
||
|
|
Bitburner is a cyberpunk hacking-themed incremental game. The game can be
|
||
|
|
played [here](https://danielyxie.github.io/bitburner).
|
||
|
|
|
||
|
|
# Documentation
|
||
|
|
The game's official documentation can be found [here](http://bitburner.readthedocs.io/en/latest/index.html). Please note that
|
||
|
|
this is still a work-in-progress and is in its early stages.
|
||
|
|
|
||
|
|
The documentation is created using Sphinx and is hosted on Read The Docs.
|
||
|
|
|
||
|
|
Anyone is welcome to contribute to the documentation by editing the source files
|
||
|
|
in /doc/ and then making a pull request with your changes/contributions.
|
||
|
|
|
||
|
|
# Wiki
|
||
|
|
The game's wiki can be found [here](http://bitburner.wikia.com/wiki/Bitburner_Wiki).
|
||
|
|
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.
|
||
|
|
|
||
|
|
# Contributing
|
||
|
|
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.
|
||
|
|
|
||
|
|
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
|
||
|
|
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.
|
||
|
|
|
||
|
|
If you would like to make significant contributions to the project as a
|
||
|
|
collaborator, please message me privately.
|