branch: externals/crdt
commit 914c6d5d947c9219a4e1fa67b0a78f55fc61b787
Author: Qiantan Hong <qh...@alum.mit.edu>
Commit: Qiantan Hong <qh...@alum.mit.edu>
Improve README
---
README.org | 63 +++++++++++++++++++++++++++++++-------------------------------
1 file changed, 31 insertions(+), 32 deletions(-)
diff --git a/README.org b/README.org
index 9e7fbb6f11..78c8edd60e 100644
--- a/README.org
+++ b/README.org
@@ -57,26 +57,26 @@ values.
If the server has provided the permission (this is the default case),
connected user may also add their buffers to the session via
=M-x crdt-share-buffer=.
-
-** List active users
-
-In a CRDT shared buffer (either server or client), =M-x
-crdt-list-users=.
-In the displayed user list, press ~RET~ on an entry to goto that
-user's cursor position. Press ~f~ to follow that user, and press ~f~
-again or =M-x crdt-stop-follow= to stop following.
+** Navigate through sessions
-You can also use =M-x crdt-goto-next-user= and =M-x
-crdt-goto-prev-user= to cycle through users' cursor positions from any
-CRDT shared buffer (don't need to be in the user list buffer).
+- Sessions :: =M-x crdt-list-sessions= lists all sessions.
+
+- Buffers :: =M-x crdt-list-buffers= lists all buffers in current
+ session. In the displayed buffer list, press ~RET~ in the session
+ list to see buffers in the selected session.
-** List all sessions, and buffer in current session
+ You can also use =M-x crdt-switch-to-buffer= to interactively switch
+ to another buffer in the current session.
-=M-x crdt-list-sessions= lists all sessions.
+- Users :: In a CRDT shared buffer (either server or client), =M-x
crdt-list-users=
+ to list active users. In the displayed user list, press ~RET~ on an
+ entry to goto that user's cursor position. Press ~f~ to follow that
+ user, and press ~f~ again or =M-x crdt-stop-follow= to stop following.
-=M-x crdt-list-buffers= lists all buffers in current session. Or you can also
-press ~RET~ in the session list to see buffers in the selected session.
+ You can also use =M-x crdt-goto-next-user= and =M-x crdt-goto-prev-user=
+ to cycle through users' cursor positions from any CRDT shared buffer
+ (don't need to be in the user list buffer).
** Stop sharing
@@ -102,24 +102,23 @@ The server Emacs has the privilege to disconnect a user
from a
session. To do so, press ~k~ or ~d~ on an entry in the user list
(show it by =M-x crdt-list-users=).
-** Visualizing author of parts of the document
+** Fancy stuff
-Turn on =crdt-visualize-author-mode=. Colored underlines are added to
-each part of the document, based on which user authored it.
-
-** Synchronizing Org folding status
-
-Turn on =crdt-org-sync-overlay-mode=. All peers that have this enabled
-have their folding status synchronized. Peers without enabling this
-minor mode are unaffected.
-
-** Comint integration
-
-Just go ahead and share you comint REPL buffer! Tested: ~shell~ and
-~cmuscheme~. By default, when sharing a comint buffer, ~crdt.el~
-temporarily reset input history (as in =M-n= =M-p=) so others don't
-spy into your =.bash_history= and alike. You can customize this
-behavior using variable =crdt-comint-share-input-history=.
+- Visualizing author of parts of the document ::
+ Turn on =crdt-visualize-author-mode= to color text based on which
+ user authored it.
+
+- Synchronizing Org folding status :: Turn on
+ =crdt-org-sync-overlay-mode=. All peers that have this enabled have
+ their folding status synchronized. Peers without enabling this minor
+ mode are unaffected.
+
+- Comint integration ::
+ Just go ahead and share you comint REPL buffer! Tested: ~shell~ and
+ ~cmuscheme~. By default, when sharing a comint buffer, ~crdt.el~
+ temporarily reset input history (as in =M-n= =M-p=) so others don't
+ spy into your =.bash_history= and alike. You can customize this
+ behavior using variable =crdt-comint-share-input-history=.
** What if we don't have a public IP?
