diff --git a/README.md b/README.md index 93c2cd7..c8cf38d 100644 --- a/README.md +++ b/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 -------------------|------------------------------------------------------------ C-c o | Open the currently visited file with an external program. +C-c i | Search for a symbol, only for buffers that contain code C-c g | Search in Google for the thing under point (or an interactive query). C-c G | Search in GitHub for the thing under point (or an interactive query). C-c y | Search in YouTube for the thing under point (or an interactive query). diff --git a/modules/doc/README.md b/modules/doc/README.md new file mode 100644 index 0000000..3ddea00 --- /dev/null +++ b/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 diff --git a/modules/doc/prelude-python.md b/modules/doc/prelude-python.md new file mode 100644 index 0000000..8de3ff6 --- /dev/null +++ b/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`.