tech
/
nuclide
2
0
Fork 0
Code Issues 33 Releases Activity
nuclide/Documentation/Contributing.md

40 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
# Contributing
If you'd like to contribute code: Awesome.
There's just 2 very short requirements.
## Rule #1
The code must be yours.
It's simple:
Import some documentation from the old wiki. Adjust formatting. Still loads to do in terms of fixing the old links.
2022-10-26 12:47:59 -07:00
Update Documentation/Materials/MatGoldSrc.md, add some example images while we're at it...
2022-10-17 12:41:14 -07:00
- Do not take code that is by anyone else that is not you.
Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
## Rule #2
Import some documentation from the old wiki. Adjust formatting. Still loads to do in terms of fixing the old links.
2022-10-26 12:47:59 -07:00
Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
No submission or decompilation of third-party code. This is important if you want to recreate behaviour from another game.
Import some documentation from the old wiki. Adjust formatting. Still loads to do in terms of fixing the old links.
2022-10-26 12:47:59 -07:00
- We do not decompile. We reverse-engineer by trial and error.
Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
This is generally referred to as 'clean-room engineering'.
Most of the behaviour is rather predictable, other is not.
This is why some of the parts of Nuclide, which emulate entities/frameworks
from other games may feel a bit off. It's because it's all implemented by eye.
# Other notes
Import some documentation from the old wiki. Adjust formatting. Still loads to do in terms of fixing the old links.
2022-10-26 12:47:59 -07:00
Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
Game specific features need to be put into game-specific directories.
Unless other games benefit from this, keep it seperate to one of the game
sub-directories. This usually means it'll be part of another git repository too.
That's about it!
# Saying Thanks
Import some documentation from the old wiki. Adjust formatting. Still loads to do in terms of fixing the old links.
2022-10-26 12:47:59 -07:00
Overhaul of the entire documentation.
2022-10-02 17:10:54 -07:00
If you want to solely say thanks, the main developer of Nuclide **loves** receiving E-Mail. You can contact him at <mailto:marco@vera-visions.com> and let him know your thoughts.
If you'd like to donate to him via [PayPal](https://paypal.me/eukara) or [Patreon](https://www.patreon.com/eukara) you can do that too. That money pays for a lot of free services he provides that come with both [FTEQW](https://www.fteqw.org/) and **Nuclide**.