README: adapt all README files to markdown
This commit is contained in:
Yvan Volochine
parent
6f808bcece
commit
ed4c7348c1
1 changed files with 54 additions and 60 deletions
114
README
114
README
|
|
@ -1,121 +1,115 @@
|
|||
-*- text -*-
|
||||
------------------------------------------------------------------------
|
||||
SCEL -- SuperCollider/Emacs interface
|
||||
------------------------------------------------------------------------
|
||||
$Id"
|
||||
------------------------------------------------------------------------
|
||||
# Scel
|
||||
|
||||
installation (requirements)
|
||||
---------------------------
|
||||
SuperCollider/Emacs interface
|
||||
|
||||
## Installation requirements
|
||||
|
||||
For the HTML help system, you will need emacs-w3m support.
|
||||
|
||||
installation (default)
|
||||
-----------------------
|
||||
## Installation (default)
|
||||
|
||||
by default emacs-lisp files are installed in
|
||||
By default emacs-lisp files are installed in
|
||||
|
||||
$prefix/share/emacs/site-lisp
|
||||
`$prefix/share/emacs/site-lisp`
|
||||
|
||||
SuperCollider files are put in
|
||||
|
||||
$prefix/share/SuperCollider/Extensions/scel
|
||||
`$prefix/share/SuperCollider/Extensions/scel`
|
||||
|
||||
the only thing you need to do is loading the sclang interface in your
|
||||
~/.emacs:
|
||||
The only thing you need to do is loading the sclang interface in your `~/.emacs`:
|
||||
|
||||
```lisp
|
||||
(require 'sclang)
|
||||
```
|
||||
|
||||
for the HTML help system to fully function also add
|
||||
For the HTML help system to fully function also add
|
||||
```lisp
|
||||
(require 'w3m)
|
||||
```
|
||||
|
||||
installation (detailed)
|
||||
------------------------
|
||||
## Installation (detailed)
|
||||
|
||||
put all *.el files in emacs' load-path. e.g. if you put them in
|
||||
~/emacs/, add the following lines to ~/.emacs (or whatever your init
|
||||
Put all `*.el` files in emacs' load-path. e.g. if you put them in
|
||||
`~/emacs/`, add the following lines to `~/.emacs` (or whatever your init
|
||||
file is called):
|
||||
|
||||
```lisp
|
||||
(add-to-list 'load-path "~/emacs")
|
||||
|
||||
and then load the library:
|
||||
|
||||
(require 'sclang)
|
||||
```
|
||||
|
||||
for the HTML help system to fully function also add
|
||||
```lisp
|
||||
(require 'w3m)
|
||||
```
|
||||
|
||||
now put all *.sc files in sclang's library path, e.g. if you put them
|
||||
in a non-standard location, such as ~/SuperCollider/Emacs/, add the
|
||||
following to ~/.sclang.cfg:
|
||||
now put all `*.sc` files in sclang's library path, e.g. if you put them
|
||||
in a non-standard location, such as `~/SuperCollider/Emacs`, add the
|
||||
following to `~/.config/SuperCollider/sclang.conf.yaml`:
|
||||
|
||||
+~/SuperCollider/Emacs
|
||||
```yaml
|
||||
includePaths:
|
||||
[~/SuperCollider/Emacs]
|
||||
```
|
||||
|
||||
(note normally this is not needed as they are put into sclang's library
|
||||
path during installation with scons).
|
||||
|
||||
|
||||
usage
|
||||
------
|
||||
## Usage
|
||||
|
||||
in order to automatically start sclang when invoking emacs, use the
|
||||
following command line:
|
||||
In order to automatically start sclang when invoking emacs, use the following command line:
|
||||
|
||||
$ emacs -sclang
|
||||
```bash
|
||||
$> emacs -sclang
|
||||
```
|
||||
|
||||
you're now ready to edit, inspect and execute sclang code!
|
||||
|
||||
getting help
|
||||
-------------
|
||||
# Getting help
|
||||
|
||||
inside an sclang-mode buffer (e.g. by editing a .sc file), execute
|
||||
Inside an sclang-mode buffer (e.g. by editing a .sc file), execute
|
||||
|
||||
C-h m
|
||||
`C-h m`
|
||||
|
||||
a window with key bindings in sclang-mode will pop up.
|
||||
and a window with key bindings in sclang-mode will pop up.
|
||||
|
||||
C-x C-h lets you search for a help file
|
||||
`C-x C-h` lets you search for a help file
|
||||
|
||||
C-M-h opens or switches to the Help browser (if no Help file has been opened, the default Help file will be opened)
|
||||
`C-M-h` opens or switches to the Help browser (if no Help file has been opened, the default Help file will be opened).
|
||||
|
||||
E copies the buffer, puts it in text mode and sclang-minor-mode, to enable you to edit the code parts to try out variations of the provided code in the help file. With C-M-h you can then return to the Help browser and browse further from the Help file.
|
||||
`E` copies the buffer, puts it in text mode and sclang-minor-mode, to enable you to edit the code parts to try out variations of the provided code in the help file. With `C-M-h` you can then return to the Help browser and browse further from the Help file.
|
||||
|
||||
C-c C-e allows you to edit the source of the HTML file, for example if you want to improve it and commit it to the repository.
|
||||
`C-c C-e` allows you to edit the source of the HTML file, for example if you want to improve it and commit it to the repository.
|
||||
|
||||
To enable moving around in the help file with arrow keys add the following
|
||||
in your ~/.emacs:
|
||||
in your `~/.emacs`:
|
||||
|
||||
```lisp
|
||||
(eval-after-load "w3m"
|
||||
'(progn
|
||||
(define-key w3m-mode-map [left] 'backward-char)
|
||||
(define-key w3m-mode-map [right] 'forward-char)
|
||||
(define-key w3m-mode-map [up] 'previous-line)
|
||||
(define-key w3m-mode-map [down] 'next-line)))
|
||||
```
|
||||
|
||||
This ensures that the arrow keys are just for moving through the document,
|
||||
and not from hyperlink to hyperlink, which is the default in w3m-mode.
|
||||
This ensures that the arrow keys are just for moving through the document, and not from hyperlink to hyperlink, which is the default in w3m-mode.
|
||||
|
||||
|
||||
customization
|
||||
--------------
|
||||
## Customization
|
||||
|
||||
to fine-tune the installation from within emacs' graphical
|
||||
customization interface, type
|
||||
To fine-tune the installation from within emacs' graphical customization interface, type:
|
||||
|
||||
M-x sclang-customize
|
||||
`M-x sclang-customize`
|
||||
|
||||
in particular, you will have to customize `sclang-runtime-directory'.
|
||||
In particular, you will have to customize `sclang-runtime-directory'.
|
||||
|
||||
server control
|
||||
---------------
|
||||
## Server control
|
||||
|
||||
in the post buffer window, right-click on the server name; by default
|
||||
the two servers 'internal' and 'localhost' are available. you will get
|
||||
a menu with common server control operations.
|
||||
In the post buffer window, right-click on the server name; by default the two servers `internal` and `localhost` are available. You will get a menu with common server control operations.
|
||||
|
||||
to select another server, step through the server list by
|
||||
left-clicking on the server name.
|
||||
|
||||
servers instantiated from the language will automatically be available
|
||||
in the mode line.
|
||||
To select another server, step through the server list by left-clicking on the server name.
|
||||
|
||||
Servers instantiated from the language will automatically be available
|
||||
in the mode line.
|
||||
Loading…
Reference in a new issue