/ngt-docs

documents for ngt (new game toolkit)

ngt

this contains documents for ngt, the new game toolkit.

in the NGT documents folder, you'll find main and libraries. the main folder is that the functions and objects which are no need of additional libraries, while the libraries folder contain functions and objects which can only be used by including additional libraries.

you can also contribute.

download

to download the zip.

  • click on the code menu.
  • click on download zip.

discussion

discussion is a place to talk and share knowledge. join the discussions to help improve the documentations!

join the discussion!

issues

issue is a place where you can submit issues. it is as the discussionboard.

join the issues!

contributing

you can help improve the documentations by contributing. not enough github knowledge to contribute? don't worry. you can improve the help by starting discussions and issues to tell other contributors what need to be fixed or added. every contribution counts and helps.

fork

your first step to be a contributor would be forking the repository.

just click on fork icon and choose the option that says contribute to the repository or something similar.

clone the forked repository

your next step is to clone your forked repository into your local device so it is easyer to write things.

it is recommended to use github desktop If you are using from the pc.

copy the link of your forked repository that you did earlyer.

next, open your github desktop. choose the option to clone the repository, and paste the link of your forked repository into the box and you're good to go.

make changes

the final step is to make changes in your local repository folder. you write the files.

then, commit your changes with helpful descriptive message.

next, push the changes into your forked repository by clicking push icon within your github environment.

go back to your forked repository on your browser. then, click on contribute submenu.

then, click on create new pull request. next, write helpful description of what you've just made changes and click on create pull request button or something similar.

updates

it is important to know that you should update your forked repository so that anything would be correct as it should be.

to do that, go back to your forked repository in your browser.

next, click on synk fork submenu. at the bottom, click on update branch button. If you can't see the button, meaning you're up to date. it will also indicate with the message that is up to date or not.