Skip to content

Commit 011222a

Browse files
Add more details to the installation instructions
1 parent 5741046 commit 011222a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,21 @@ git config --global url."http://gitcache:1234/".insteadOf https://
4444

4545
Requirements: `nodejs` and `git`.
4646

47-
Install: `npm install --global git-cache-http-server`.
47+
```
48+
npm install --global git-cache-http-server
49+
```
4850

49-
To install as a service, check the `doc/git-cache-http-server.service` example
50-
service file.
51+
To install a cache service on Linux systems, check the example
52+
`doc/git-cache-http-server.service` unit file.
5153

52-
For Systemd init users, this file should not require major tweaks other than
54+
For Systemd init users that file should not require major tweaks, other than
5355
specifying a different than default port number or cache directory. After
54-
installed in the proper Systemd unit path for your distribution, issue:
56+
installed in the proper Systemd unit path for your distribution:
5557

5658
```
5759
systemctl daemon-reload
5860
systemctl start git-cache-http-server
61+
systemctl enable git-cache-http-server
5962
```
6063

6164
# Working with the Haxe sources
@@ -69,10 +72,13 @@ transparently with the usual npm commands. The resulting JS script will be
6972
placed in `bin/`.
7073

7174
```
72-
# install development dependencies and build
75+
# clone the repository (adjust the protocol)
76+
git clone https://github.com/jonasmalacofilho/git-cache-http-server
77+
78+
# install development dependencies and build the sources
7379
npm install
7480
75-
# install the built package globally
81+
# install the built code globally (might require sudo)
7682
npm install --global
7783
```
7884

0 commit comments

Comments
 (0)