Table of Contents
General Explanation about the project, Why you made this, What does it do exactly.
Project dependencies
example :
- Make
# in Linux sudo apt install make
- Python
# in Linux sudo apt install python3
How to install and use your project
- Clone the repo
git clone https://github.com/NoHaitch/Repository_Template
- Change the content
Instruction to run/build/etc the program
example:
make build
: To build from source to binary into bin/main
make all
: Run binary directly after building
make clean
: Remove all build generated files
make ADT.test
: Running test for ADT test file, for example ( make time.test
)
make test.all
: Running all test
this feature does X
this feature does Y
sub-features:
- function 1
- function 2
- function 3
this feature does Z
A
: print A.B
: print B.C
: print C.
If you want to contribute or further develop the program, please fork this repository using the branch feature.
Pull Request is permited and warmly welcomed
The code in this project is licensed under MIT license.