sad/soju
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Simon Ser 2021-04-19 16:35:18 +02:00
parent c994ce7092
commit c8ccc641d9
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -12,14 +12,14 @@ A user-friendly IRC bouncer.
## Usage ## Usage
See the man page at `doc/soju.1.scd` for more information. See the man page for more information.
### Server side ### Server side
To create an admin user and start soju, run these commands: To create an admin user and start soju, run these commands:
go run ./cmd/sojuctl create-user <soju username> -admin sojuctl create-user <soju username> -admin
go run ./cmd/soju -listen irc+insecure://127.0.0.1:6667 soju -listen irc+insecure://127.0.0.1:6667
If you're migrating from ZNC, a tool is available to import users, networks and If you're migrating from ZNC, a tool is available to import users, networks and
channels from a ZNC config file: channels from a ZNC config file:
@ -65,9 +65,14 @@ name:
/join #soju/freenode /join #soju/freenode
/join #somechannel/rizon /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 ## Contributing