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

git-svn-id: https://svn.yakumo.dev/yakumo.izuru/suika/trunk@504 f0ae65fe-ee39-954e-97ec-027ff2717ef4
This commit is contained in:
contact 2021-04-19 14:35:18 +00:00
parent 454278bcff
commit b01ff0ed31

View File

@ -12,14 +12,14 @@ A user-friendly IRC bouncer.
## Usage
See the man page at `doc/soju.1.scd` for more information.
See the man page for more information.
### Server side
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
channels from a ZNC config file:
@ -65,9 +65,14 @@ name:
/join #soju/freenode
/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