aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Allred <code@seanallred.com>2014-12-02 11:27:52 -0500
committerSean Allred <code@seanallred.com>2014-12-02 11:27:52 -0500
commite556a8127ab976725729b3221d82db990e9a27b9 (patch)
tree06e470cf4d08d4c40837879a6fb48eab7fe0ea82
parent07dc04e1e5111fff7f2905a155271edde3ce754c (diff)
Update README with some basic instructions.
Notes: `sx-tab' should not need to be required. The necessary functions should be auto-loaded.
-rw-r--r--README.org17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.org b/README.org
index df8d907..db75b90 100644
--- a/README.org
+++ b/README.org
@@ -40,11 +40,28 @@ To install the development version, follow the usual steps:
- Clone this repository
- Add this directory to your ~load-path~
- Issue ~(require 'sx)~
+- Issue ~(require 'sx-tab)~
This should give you access to the only entry point function at the
moment, ~sx-tab-frontpage~.
Eventually, this package will be available on MELPA.
+** Some Basic Controls
+- =RET= :: interact with things under point (collapse headers, visit
+ links, etc.)
+- =TAB= :: go to next element
+- =n= :: go to next section
+- =p= :: go to previous section
+- =j= :: go to next question, viewing it
+- =k= :: go to previous question, viewing it
+- =v= :: visit a question on the browser
+- =w= :: copy things under point (usually a url)
+- =e= :: edit
+- =a= :: answer
+- =c= :: comment
+- =u= :: vote up
+- =d= :: vote down
+
* Contributing
Please help contribute! Doing any of the following will help us immensely:
- [[https://github.com/vermiculus/sx.el/issues/new][Open an issue]]