Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create root README.md #1710

Merged
merged 2 commits into from
Jan 17, 2025
Merged

Create root README.md #1710

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f434986
Create root README.md
agguillemot Aug 16, 2023
8b3ee0e
Apply suggestions from code review
demorose Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions generators/root/templates/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# README

## Prerequisites

Docker and docker-compose must be installed and running.

## Install

Simply run the following script to install dependencies

```
./script/bootstrap
```

## Run

Launch your containers by using :

```
./script/server
```

The project is available on localhost:80

Loading