diff --git a/README.md b/README.md index 5fbdf2a..bbf3520 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # Gocirc -a lightweight IRC server written in Golang \ No newline at end of file +a lightweight IRC server written in Golang + +## setup +1. cloning the repository +``` +git clone ssh://git@git-ssh.anarchists.space:222/meer/Gocirc.git +cd Gocirc +``` +2. compiling the server +``` +chmod +x build.sh +./build.sh +``` + +3. setting up configuration file +example JSON config +```JSON +{ + "port": 6667, + "webapiport": 7880, + "motd": "", + "enableserverpassword": true, + "serverpassword": "YOUR_SERVERPASSWORD", + "channels": [ + { + "channel": "#main", + "description": "the main channel" + } + ], + "ops": [ + "admin" + ] +} +``` +change values as needed + \ No newline at end of file