Skip to content
Browse files

doc ++

  • Loading branch information...
1 parent baecbc9 commit 342f1a0be0f00de5efa8baca7172962ac542ff3f @wuub wuub committed Mar 10, 2012
Showing with 26 additions and 5 deletions.
  1. BIN doc/_static/menu.png
  2. BIN doc/_static/palette.png
  3. +1 −1 doc/conf.py
  4. +24 −4 doc/index.rst
  5. +1 −0 gitready.bat
View
BIN doc/_static/menu.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN doc/_static/palette.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
2 doc/conf.py
@@ -50,7 +50,7 @@
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
-release = '1.0.15'
+release = '1.0.20'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
View
28 doc/index.rst
@@ -6,20 +6,38 @@
SublimeREPL
===========
-SublimeREPL is a plugin for Sublime Text 2 that adds a way to run interactive
-interpreters of several languages within a normal editor tab. It also allows
+SublimeREPL is a plugin for Sublime Text 2 that lets tou run interactive
+interpreters of several languages within a normal tab. It also allows
connecting to a remote interpreter (e.g. Clojure/Lein) though a telnet port.
SublimeREPL has a built-in support for command history and transferring code from
-open buffers to the interpreter for evaluation.
-
+open buffers to the interpreters for evaluation.
Installation
------------
+Download `Package Control`__, select Install Package and pick SublimeREPL from the list of
+available packages.
+
+__ http://wbond.net/sublime_packages/package_control
+
+
Quick Start
-----------
+SublimeREPL adds itself as a submenu in Tools. You can choose any one of the preconfigured REPLs and
+if it's available in your SYSTEM PATH [#]_, it will be launched immediately.
+
+.. image:: _static/menu.png
+
+Second and more user friendly way to launch any given REPL is through Command Palette. Bring up Command Palette and type "repl". You will be presented
+with all preconfigured REPLs. Running REPL through Command Palette has exactly the same result as picking it from *Tools > SublimeREPL* menu.
+
+.. image:: _static/palette.png
+
+.. [#] One of the most frequently reported errors is SublimeREPL not being able to find interpreter executable, even if it's visible in your shell. There are several way to fix this problem that we'll discuss in FAQ.
+
+
Keyboard Shortcuts
------------------
@@ -29,6 +47,8 @@ Language specific information
Configuration
-------------
+Frequently Asked Questions
+--------------------------
View
1 gitready.bat
@@ -0,0 +1 @@
+hg bookmark -r default master -f

0 comments on commit 342f1a0

Please sign in to comment.
Something went wrong with that request. Please try again.