Restructure the README into a manual

This commit is contained in:
Bozhidar Batsov 2019-01-16 14:31:52 +02:00
parent 63c697c2f4
commit 4490d51798
17 changed files with 789 additions and 684 deletions

50
doc/modules/erc.md Normal file
View file

@ -0,0 +1,50 @@
# Prelude ERC
## Customizing Server list
If you want to join a list of servers on `M-x start-irc`, other than
the default list, please redefine the variable `my-fav-irc` as follows
in your personal config
``` emacs-lisp
(setq my-fav-irc '("irc.freenode.net"
"irc.oftc.net"
"irc.mozilla.org"
"irc.gnome.org"))
```
## Customizing Last Quit Message
If you want to customize your IRC Last Quit Message from *Asta la
vista* to something more funkier, please redefine `bye-irc-message` as
follows
``` emacs-lisp
(setq bye-erc-message "adios")
```
## Reading NickServ passwords from auth-source plugin
If you want to automatically authenticate while logging into IRC
servers set the `erc-prompt-for-password` to nil as follows
``` emacs-lisp
(setq erc-prompt-for-password nil)
```
Now you can set password in plaintext in .authinfo file in the netRC
format or you it encrypted in .authinfo.gpg file after setting up gpg
in emacs
## Opening all ERC buffers in a new perspective
Many a time when we start IRC with the `start-irc` command, all the
channels open in our existing workspace, which can be annoying to
some; especially to those who like to organize their buffers into
separate groups (perspectives). To avoid this scenario, it is better
to group all the ERC buffers into one perspective called `IRC` when
`start-irc` is called. To enable this set the `prelude-new-irc-persp`
variable to true as follows
``` emacs-lisp
(setq prelude-new-irc-persp t)
```

29
doc/modules/index.md Normal file
View file

@ -0,0 +1,29 @@
# 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](erc.md)
- Erlang
- Elixir
- Haskell
- JS
- Latex
- Lisp
- Markdown
- Org
- Perl
- [Python](python.md)
- Ruby
- Scala
- Scheme
- Scss
- Web

18
doc/modules/python.md Normal file
View file

@ -0,0 +1,18 @@
# Prelude Python
## 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`.