From 679020395864c10e22eca480711f531c6583dbbb Mon Sep 17 00:00:00 2001
From: depate <gutluft@outlook.com>
Date: Thu, 11 Oct 2018 19:14:24 +0200
Subject: Commands are invoked with a leading slash (like in Wiki). This patch
 makes that clear on the landing page

---
 README.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 79509d3..829fa04 100644
--- a/README.md
+++ b/README.md
@@ -32,13 +32,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
-- 
cgit v1.2.3


From e0e2b4f2f14bea1453ff54de12eecec4c7d70f04 Mon Sep 17 00:00:00 2001
From: Tulir Asokan <tulir@maunium.net>
Date: Thu, 18 Oct 2018 15:55:17 +0300
Subject: Add basic development instructions

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 829fa04..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) - `↑` `↓`
@@ -41,4 +55,4 @@ or compile from source:
 * `/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
+* `/setstate <room id> <event type> <state key/-> <content>` - Change room state
-- 
cgit v1.2.3