summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGaute Hope <eg@gaute.vetsj.com>2017-11-20 19:49:56 +0100
committerGaute Hope <eg@gaute.vetsj.com>2017-11-20 19:50:04 +0100
commit057729e690dcbba6bf5f2135e6b4b96e317becc1 (patch)
treeceb30b3c399a8ca1e4a0d1d282e3da1a63fcba26 /README.md
parentcdbdf33c22f2216342b62e3504fc71eb5c9f34dc (diff)
readme: typos + clarify running
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index fcf6198..7cbba0f 100644
--- a/README.md
+++ b/README.md
@@ -55,16 +55,16 @@ $ cmake -H. -Bbuild -GNinja -DCMAKE_INSTALL_PREFIX=/usr/local
$ cmake --build build --target install
```
-this will install the `astroid` binary into `/usr/local/bin/`, and data files into `/usr/local/share/astroid/`. refer to the [installing section](https://github.com/astroidmail/astroid/wiki/Compiling-and-Installing) in the wiki for more information.
+this will install the `astroid` binary into `/usr/local/bin/`, and data files into `/usr/local/share/astroid/`. Refer to the [installing section](https://github.com/astroidmail/astroid/wiki/Compiling-and-Installing) in the wiki for more information.
### configuration
-The initial run of `astroid` will create a new configuration file in `$XDG_CONFIG_HOME/astroid` (normally: `~/.config/astroid/`. refer to the [configuration section](https://github.com/astroidmail/astroid/wiki/Astroid-setup) in the wiki for more information.
+The initial run of `astroid` will create a new configuration file in `$XDG_CONFIG_HOME/astroid` (normally: `~/.config/astroid/`). Refer to the [configuration section](https://github.com/astroidmail/astroid/wiki/Astroid-setup) in the wiki for more information.
### execution and usage
```sh
-$ ./build/astroid
+$ ./build/astroid # to run from source repository
```
press `?` to get a list of available key bindings in the current mode, navigate up and down using `j` and `k`. refer to the [usage section](https://github.com/astroidmail/astroid/wiki#usage) in the wiki for more information on usage and customization.