summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGaute Hope <eg@gaute.vetsj.com>2017-11-14 12:39:27 +0100
committerGaute Hope <eg@gaute.vetsj.com>2017-11-14 13:52:57 +0100
commit3762a8c896a12e9dcbaaa0b290b5cc8e51ad0be2 (patch)
tree5f35ebd0cd5e64a34282b6e65670d5ea4ad74e17 /README.md
parent02430a5e824fd751a6393324803f63545fb42b81 (diff)
cmake: use cmake in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index d8ea37a..c857de3 100644
--- a/README.md
+++ b/README.md
@@ -33,30 +33,29 @@ $ git clone https://github.com/astroidmail/astroid.git
### compiling
```sh
-$ meson build
-$ cd build/
-$ ninja
+$ cd astroid
+$ cmake -H. -Bbuild -GNinja # to use the ninja backend
+$ cmake --build build
```
-or run `meson configure` from `build/` to set any build options. Subsequent builds can be done by running `ninja` from the build directory.
+run `cmake -DOPTION=VALUE .` from `build/` to set any build options (list with `cmake -L`). Subsequent builds can be done by running `ninja` (or `make` if you are using that) from the build directory.
to run the tests do:
```sh
-$ ninja test
+$ cd build
+$ ctest
```
### installing
Configure with a prefix and install:
```sh
-$ meson build --prefix=/usr
-$ cd build/
-$ ninja
-$ ninja install
+$ cmake -H. -Bbuild -GNinja -DCMAKE_INSTALL_PREFIX=/usr/local
+$ cmake --build build --target install
```
-this will install the `astroid` binary into `/usr/bin/`, and data files into `/usr/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
@@ -65,7 +64,7 @@ The initial run of `astroid` will create a new configuration file in `$XDG_CONFI
### execution and usage
```sh
-$ ./astroid
+$ ./build/astroid
```
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.