README.adoc for GitHub project (startup Asciidoctor template)

README-with-toc-and-back-to-top.adoc

My Project

Summary

• 1. Presentation
• 2. Prerequisites
• 3. Installation
• 4. Resources
• 5. Comments, suggestions?
• 6. License

1. Presentation

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

📎	Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

⬆ Back to top

2. Prerequisites

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

⬆ Back to top

3. Installation

1. $ git clone git@github.com:username/project.git.

2. $ cd project.

3. $ make start (Build fresh images & Up).

4. Open your browser on http://localhost:4200/.

📎	Use $ make to see all available commands.

⬆ Back to top

4. Resources

• https://github.com/

• https://github.blog/

• https://gist.github.com/

• https://badgen.net/

⬆ Back to top

5. Comments, suggestions?

Feel free to make comments/suggestions to me in the Git issues section.

⬆ Back to top

6. License

"My Project" is released under the MIT License.

---

⬆ Back to top

README.adoc

My Project

Summary

• Presentation
• Prerequisites
• Installation
  • 1. Clone the project
  • 2. Go in the folder project
  • 3. Start the project
  • 4. Open the project in you browser
  • All in one line
• Resources
• Comments, suggestions?
• License

Presentation

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

📎	Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Prerequisites

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Installation

1. Clone the project

git clone git@github.com:username/project.git

2. Go in the folder project

cd project

3. Start the project

make start

4. Open the project in you browser

• Go on http://localhost:4200/

All in one line

git clone git@github.com:username/project.git\
cd project\
make start

📎	Use $ make to see all available commands.

Resources

• https://github.com/

• https://github.blog/

• https://gist.github.com/

• https://badgen.net/

Comments, suggestions?

Feel free to make comments/suggestions to me in the Git issues section.

License

"My Project" is released under the MIT License.

README.md

My project

Presentation

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

In this file, replace __GIT_USERNAME__ and __GIT_PROJECT__ with the good values, and remove this block.

Prerequisites

Be sure to install the latest version of:

• Docker Engine;
• Symfony CLI;
• NVM;

Installation

The very first cloning of the project

1 - Clone the project

git clone git@github.com:__GIT_USERNAME__/__GIT_PROJECT__.git

2 - Go in the folder project

cd __GIT_PROJECT__

3 - Launch the project

make start

4 - Go on http://localhost:4200/

All in one command

git clone git@github.com:__GIT_USERNAME__/__GIT_PROJECT__.git;\
cd __GIT_PROJECT__;\
make start

The following times

1 - Launch the project

make start

2 - Go on http://localhost:4200/

3 - Stop the project

make stop

Open the project in StackBlitz

Go on https://stackblitz.com/github/__GIT_USERNAME__/__GIT_PROJECT__/

Essential commands

make

Semantic versioning

v[MAJOR].[MINOR].[PATCH]

See https://semver.org/

Resources

• https://github.com/
• https://github.blog/
• https://gist.github.com/
• https://stackblitz.com/
• StackBlitz: Launching projects from GitHub
• https://badgen.net/

Comments, suggestions?

Feel free to make comments/suggestions to me in the Git issues section.

License

This project is released under the MIT License.