From 7216f9cc82ccfc72d66bff0e8cbb336cf95d646d Mon Sep 17 00:00:00 2001 From: HampusM Date: Sat, 29 May 2021 18:29:22 +0200 Subject: Fixed the formatting and stuff in the readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3-18-g5258