-
Notifications
You must be signed in to change notification settings - Fork 0
Home
In this document I will discuss how I laid out the wiki pages for this repository, getting started, and briefly discuss the code of conduct, issue template, and pull request here. So going into the layout of this wiki here I will have the most general information and possibly a quick memo if there is something important I want people to see.
I know that this repository is not going to attract a big audience / community but I wanted to have something basic in place that covered the area. As the Code Of Conduct states I will not allow any type of bullying anywhere within this repository. Now I have also included an issue and pull request template. I want everyone who wants to work on the project to fork the repository and make their issue / pull request from there, it will make all of our lives easier. Please try and follow the templates that I have laid out in the repository, they are simple enough to follow.
Getting started is super easy, all you have to do is run the setup script in the main directory, and let it build. When it is finished, move within the build directory, run the following command: ./Thurs and it will run. There is nothing to configure, but give the project a second to setup. From there do these helpful commands separate to get started: commands, and usage.
Thanks,