aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-12-29 14:37:35 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-12-29 14:37:35 +0000
commit8854ae134dd3366eae8602d9315af1620967de01 (patch)
tree0231a683856d07f5532d6e1c00a1f40439007afb
parentPKGBUILD: add 'wayland-protocols' to makedepends (diff)
README: use triple quoted blocks for meson/ninja examples
This allows us to specify which syntax highlighting (sh) to use.
-rw-r--r--README.md30
1 files changed, 18 insertions, 12 deletions
diff --git a/README.md b/README.md
index e45615d5..eebc3289 100644
--- a/README.md
+++ b/README.md
@@ -273,31 +273,37 @@ you intend to install a release build of foot, in which case you might
be interested in the compiler flags used there.
First, create a build directory, and switch to it:
-
- mkdir -p bld/debug && cd bld/debug
+```sh
+mkdir -p bld/debug && cd bld/debug
+```
Second, configure the build (if you intend to install it globally, you
might also want `--prefix=/usr`):
-
- meson --buildtype=debug ../..
+```sh
+meson --buildtype=debug ../..
+```
Three, build it:
-
- ninja
+```sh
+ninja
+```
You can now run it directly from the build directory:
-
- ./foot
+```sh
+./foot
+```
But note that it will default to `TERM=foot`, and that this terminfo
has not been installed yet. However, most things should work with the
`xterm-256color` terminfo:
-
- ./foot --term xterm-256color
+```sh
+./foot --term xterm-256color
+```
But, I **recommend** you install the `foot` and `foot-direct` terminfo
files. You can either copy them manually (typically to
`/usr/share/terminfo/f` - but this is dependens on the distro), or
just install everything:
-
- ninja install
+```sh
+ninja install
+```