aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md34
1 files changed, 24 insertions, 10 deletions
diff --git a/README.md b/README.md
index 79509d3..ccabc5a 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,20 @@ or compile from source:
1. Run `go get -u maunium.net/go/gomuks`
2. gomuks should now be in `$GOPATH/bin/gomuks`
+## Developing
+Running `go install` in `$GOPATH/src/maunium.net/go/gomuks` will recompile the project and dependencies into `$GOPATH/bin/gomuks`.
+
+For debugging, use `tail -f /tmp/gomuks-debug.log` and write to it using the methods in the `maunium.net/go/gomuks/debug` package:
+```go
+import (
+ "maunium.net/go/gomuks/debug"
+)
+...
+func Foo() {
+ debug.Print("WHY ISN'T IT WORKING?!?!?")
+}
+```
+
## Usage
- switch rooms - `Ctrl + ↑` `Ctrl + ↓` `Alt + ↑` `Alt + ↓`
- scroll chat (line) - `↑` `↓`
@@ -32,13 +46,13 @@ or compile from source:
- jump to room - `Alt + Enter`, then `Tab` and `Enter` to navigate and select room
### Commands
-* `help` - Is a known command
-* `me <text>` - Send an emote
-* `quit` - Close gomuks
-* `clearcache` - Clear room state and close gomuks
-* `leave` - Leave the current room
-* `join <room>` - Join the room with the given room ID or alias
-* `toggle <rooms/users/baremessages/images/typingnotif>` - Change user preferences
-* `logout` - Log out, clear caches and go back to the login view
-* `send <room id> <event type> <content>` - Send a custom event
-* `setstate <room id> <event type> <state key/`-`> <content>` - Change room state
+* `/help` - Is a known command
+* `/me <text>` - Send an emote
+* `/quit` - Close gomuks
+* `/clearcache` - Clear room state and close gomuks
+* `/leave` - Leave the current room
+* `/join <room>` - Join the room with the given room ID or alias
+* `/toggle <rooms/users/baremessages/images/typingnotif>` - Change user preferences
+* `/logout` - Log out, clear caches and go back to the login view
+* `/send <room id> <event type> <content>` - Send a custom event
+* `/setstate <room id> <event type> <state key/-> <content>` - Change room state