Repository title

Brief description of your repository.

Features • Requirements • Description • Use • Install & Run • Compile & Run • Build & Run • Contributing • References • License

Brief demonstration of what your repository does in a gif or an image.

Features

• No installation necessary - just use the binary.
• Easy to modify.
• Multi-Platform
  • Windows, macOS and Linux.
• Etc...

Description

A description of your repository.

Use

#include <iostream>

int main()
{
  // ...

  std::cout << "Hello World!!!";

  return EXIT_SUCCESS;

  // ...
}

Requirements

• git
• Etc...

Install & Run

To clone this repository, you'll need to have git installed on your computer.
From your command line:

git clone https://github.com/CM0use/README-TEMPLATE.git
cd README-TEMPLATE

Run on macOS & Linux:

nano README.md

Run on Windows:

README.md

Compile & Run

Windows

Instructions for Windows

Linux/macOS

Instructions for Linux/macOS

Build & Run

Windows

Instructions for Windows

Linux/macOS

Instructions for Linux/macOS

Contributing

Any contribution you make will be greatly appreciated.
If you have any ideas/suggestions to improve this repository, make a fork and create a pull request.
You can also open the issue tracker to report any improvements or bugs.

References

Like the acknowledgments.

License

Distributed under the GNU General Public License v3.0
See accompanying file LICENSE
or copy at GNU General Public License

Acknowledgements

Resources I have relied on to make this repository:

• shields.io
• README readme-templates
• README electron-markdownify
• README readme-template
• README joe
• Best-README-Template
• README readme-template
• README simplewall
• ROT13 table with example