Merge pull request #406 from climatewarrior/add-prelude-python-docs

Add prelude-python documentation

README.md

@@ -116,7 +116,7 @@ there are such).
 
 ## Enabling additional modules
 
-By default most of the modules that ship with Prelude are not loaded.
+By default most of the modules that ship with Prelude are not loaded. For more information on the functionality provided by these modules visit the [docs](modules/doc/README.md).
 
 ```lisp
 ;;; Uncomment the modules you'd like to use and restart Prelude afterwards
@@ -225,6 +225,7 @@ Keybinding         | Description
 Keybinding         | Description
 -------------------|------------------------------------------------------------
 <kbd>C-c o</kbd>   | Open the currently visited file with an external program.
+<kbd>C-c i</kbd>   | Search for a symbol, only for buffers that contain code
 <kbd>C-c g</kbd>   | Search in Google for the thing under point (or an interactive query).
 <kbd>C-c G</kbd>   | Search in GitHub for the thing under point (or an interactive query).
 <kbd>C-c y</kbd>   | Search in YouTube for the thing under point (or an interactive query).

modules/doc/README.md

@@ -0,0 +1,29 @@
+# Emacs Prelude Modules
+
+Prelude provides extra functionality through modules. Some modules may
+require extra steps to enable all functionality. These steps and the
+functionality provided by these modules are documented on the
+following links.
+
+-   C
+-   Clojure
+-   Coffee
+-   Common-Lisp
+-   CSS
+-   Emacs-Lisp
+-   ERC
+-   Erlang
+-   Haskell
+-   JS
+-   Latex
+-   Lisp
+-   Markdown
+-   MediaWiki
+-   Org
+-   Perl
+-   [Python](prelude-python.md)
+-   Ruby
+-   Scala
+-   Scheme
+-   Scss
+-   Web

modules/doc/prelude-python.md

@@ -0,0 +1,18 @@
+# Prelude Python Quickstart
+
+## Python Mode
+
+Emacs comes with Python programming support through the built-in
+Python-mode. Whenever you are editing Python code run `C-h m` to
+look at the Python mode key bindings. Alternatively look at the
+menu bar entries under Python. To toggle the menu bar press `F12`.
+
+## Syntax checking
+
+Prelude ships with [Flycheck](https://github.com/flycheck/flycheck),
+an on the fly syntax checker. Flycheck has support for two Python
+syntax checkers, [Pylint](http://www.pylint.org/) and
+[Flake8](http://flake8.readthedocs.org/en/latest/). In
+order to have Flycheck support on the fly syntax checking for
+Python you need to have either of these installed and accessible to
+Emacs. In order to manually choose a checker run `C-c ! s`.