Browse Source

Improve install instructions

docs/README
Sheogorath 6 years ago
parent
commit
a80271ec20
No known key found for this signature in database GPG Key ID: 1F05CC3635CDDFFD
  1. 19
      README.md

19
README.md

@ -3,9 +3,26 @@ ircd-js
A simple IRCd project to provide an IRCd.
Installing dependencies
===
```bash
# Installing docker on (latest) Ubuntu
sudo apt-get install docker.io
```
Running
===
Staring a NodeJS container:
```bash
docker run -v $PWD:/app --workdir /app -p 127.0.0.1:6667:6667 --rm -it node:10 /bin/bash
```
Commands to run inside the container:
```bash
# Install all dev dependencies
npm install
@ -14,5 +31,5 @@ npm install
npm test
# Start the index.js
npm start
node index.js
```
Loading…
Cancel
Save