Skip to content

Commit 9279184

Browse files
committed
Refactors example for Setup section of README template
Why: * When using this template, I missed the git repo name in the clone command because I searched for `PROJECT_NAME` * The `cd` command, albeit being obvious for us, was missing from the example. And I believe we can be more direct to the reader and not describe every single command individually
1 parent df51f71 commit 9279184

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

github/templates/README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,17 @@ Short project description. You can use the client's pitch. No more than ten line
2727
Setup
2828
-----
2929

30-
A set of instructions to install the project. It can start with a list of dependencies, like databases, and finish with the instructions. For instance:
30+
A set of instructions to install the project. It can start with a list of dependencies, like databases, and finish with the instructions, or it can be a simple list of commands. For instance:
3131

32-
First clone the repository to your file system:
33-
34-
```
35-
git clone git@github.com:subvisual/guides.git
36-
```
37-
38-
After, run the setup script:
32+
First, clone & setup the repository:
3933

4034
```
35+
git clone git@github.com:subvisual/PROJECT_NAME.git
36+
cd PROJECT_NAME
4137
bin/setup
4238
```
4339

44-
To finish, open the file `.env` and replace the values accordingly.
40+
After that, open the `.env` file in your editor and fill in the required secret values.
4541

4642
Development
4743
-----------

0 commit comments

Comments
 (0)