branch: externals/crdt
commit 958394ad99d176235fdabaf0ab3e644b98b8c02b
Author: Qiantan Hong <qh...@mit.edu>
Commit: Qiantan Hong <qh...@mit.edu>
doc
---
README.org | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index 9ecf55d..2e0ad26 100644
--- a/README.org
+++ b/README.org
@@ -8,28 +8,28 @@ Highlights:
- (experimental) synchronize Org mode folding status
* Usage
** Installation
-Just `M-x load-file` `crdt.el`, or `M-x eval-buffer` in `crdt.el`,
-or `(require 'crdt)`. Or whatever package management tool you use.
+Just =M-x load-file= =crdt.el=, or =M-x eval-buffer= in =crdt.el=,
+or =(require 'crdt)=. Or whatever package management tool you use.
** Share a buffer
-In that buffer, `M-x crdt-share-buffer`. Then enter session name.
+In that buffer, =M-x crdt-share-buffer=. Then enter session name.
If a new session is to be created, enter port, optional password and your
display name.
If there's a existing session with the name, current buffer is added to that
session.
** Connect to a shared buffer
-`M-x crdt-connect`
+=M-x crdt-connect=
** List active users.
-In a CRDT shared buffer (either server or client), `M-x crdt-list-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.
** List all sessions, and buffer in current session.
-`M-x crdt-list-sessions` lists all sessions.
-`M-x crdt-list-buffers` lists all buffers in current session. Or you can also
+=M-x crdt-list-sessions= lists all sessions.
+=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.
** Stop sharing.
-`M-x crdt-stop-session` stops the current session. You can also press ~k~ in
the session list.
+=M-x crdt-stop-session= stops the current session. You can also press ~k~ in
the session list.
-`M-x crdt-stop-share-buffer` removes current buffer from its CRDT session
+=M-x crdt-stop-share-buffer= removes current buffer from its CRDT session
(this operation is only allowed at server side). Or press ~k~ in the buffer
list.
** Synchronizing Org folding status
-Turn on `crdt-org-sync-overlay-mode`. All peers that have this enabled have
their
+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.
