Name of the project

Additional information or tagline

A brief description of your project, what it is used for and how does life get awesome when someone starts to use it.

Installing / Getting started

A quick introduction of the minimal setup you need to get a hello world up & running.

packagemanager install awesome-project
awesome-project start
awesome-project "Do something!"  # prints "Nah."

Here you should say what actually happens when you execute the code above.

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/your/awesome-project.git
cd awesome-project/
packagemanager install

And state what happens step-by-step.

If your project needs some additional steps for the developer to build the project after some code changes, state them here:

make build
make run
make bash

Here again you should state what actually happens when the code above gets executed.

In case there's some step you have to take that publishes this project to a server, this is the right time to state it.

packagemanager deploy awesome-project -s server.com -u username -p password

And again you'd need to tell what the previous code actually does.

What's all the bells and whistles this project can perform?

Here you should write what are all of the configurations a user can enter when using the project.

Type: String
Default: 'default value'

State what an argument does and how you can use it. If needed, you can provide an example below.

Example:

awesome-project "Some other value"  # Prints "You're nailing this readme!"

Please read CONTRIBUTING.md for details on our the process for submitting pull requests and code of conduct.

This project is licensed under the MIT License - see the LICENSE.md file for details.