Changeset 504 in code for trunk

Timestamp:

Apr 19, 2021, 2:35:18 PM (4 years ago)

Author:

contact

Message:

readme: mention Makefile, assume soju is installed system-wide

File:

• trunk/README.md (modified) (3 diffs)

trunk/README.md

@@ -13 +13 @@
 ## Usage
 
-See the man page at `doc/soju.1.scd` for more information.
+See the man page for more information.
 
 ### Server side
@@ -19 +19 @@
 To create an admin user and start soju, run these commands:
 
-    go run ./cmd/sojuctl create-user <soju username> -admin
-    go run ./cmd/soju -listen irc+insecure://127.0.0.1:6667
+    sojuctl create-user <soju username> -admin
+    soju -listen irc+insecure://127.0.0.1:6667
 
 If you're migrating from ZNC, a tool is available to import users, networks and
@@ -66 +66 @@
     /join #somechannel/rizon
 
-#### Notes
+## Building and installing
 
-soju will automatically save and restore the channels you were connected to.
+For end users, a `Makefile` is provided:
+
+    make
+    sudo make install
+
+For development, you can use `go run ./cmd/soju` as usual.
 
 ## Contributing