aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2021-05-29 18:29:22 +0200
committerHampusM <hampus@hampusmat.com>2021-05-29 18:29:22 +0200
commit7216f9cc82ccfc72d66bff0e8cbb336cf95d646d (patch)
tree20a3c8d3a33d49edabd85524deab554900b3a511 /README.md
parentf3a598924fe4d4801f70238abef1ba0b948cf5e6 (diff)
Fixed the formatting and stuff in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2aef05a..570437c 100644
--- a/README.md
+++ b/README.md
@@ -33,10 +33,12 @@ Githermit will probably **never** be as fast as cgit, Gitweb & Stagit. But that'
- Nodejs v14.16.0
Install all the dependencies
-`npm install`
+
+`$ npm install`
Build & bundle the frontend
-`npm run build`
+
+`$ npm run build`
Create a file called `settings.yml` with following content
```
@@ -48,12 +50,13 @@ base_dir: (directory where all of your bare Git repositories are located)
```
You can now run it with
-`npm start`
+`$ npm start`
# Development
You're highly encouraged to [create a merge request](https://gitlab.com/HampusMat/githermit/-/merge_requests/new) if you're willing to contribute.
You can run the following command to easily get started with contributing
-`npm run dev`
+
+`$ npm run dev`
This will run an instance of Githermit with live-updating backend & frontend. \ No newline at end of file