Improve code snippet rendering in README

This converts the code snippets to the alternate block definition and
adds language hints to enable syntax highlighting for compatible parsers
(such as on the GitHub page).

Signed-off-by: Lucas Schwiderski <lucas@lschwiderski.de>
This commit is contained in:
Lucas Schwiderski 2021-03-10 22:50:24 +01:00
parent 849a8b5af4
commit cce8e80cbd
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 30 additions and 14 deletions

View File

@ -8,34 +8,42 @@ Awesome is a highly configurable, next generation framework window manager for X
After extracting the dist tarball, run: After extracting the dist tarball, run:
make ```sh
make
```
This will create a build directory, run `cmake` in it and build Awesome. This will create a build directory, run `cmake` in it and build Awesome.
After building is finished, you can either install via `make install`: After building is finished, you can either install via `make install`:
make install # you might need root permissions ```sh
make install # you might need root permissions
```
or by auto-generating a .deb or .rpm package, for easy removal later on: or by auto-generating a .deb or .rpm package, for easy removal later on:
make package ```sh
make package
sudo dpkg -i awesome-x.y.z.deb sudo dpkg -i awesome-x.y.z.deb
# or # or
sudo rpm -Uvh awesome-x.y.z.rpm sudo rpm -Uvh awesome-x.y.z.rpm
```
NOTE: Awesome uses [`cmake`](https://cmake.org) to build. In case you want to NOTE: Awesome uses [`cmake`](https://cmake.org) to build. In case you want to
pass arguments to `cmake`, please use the `CMAKE_ARGS` environment variable. For pass arguments to `cmake`, please use the `CMAKE_ARGS` environment variable. For
instance: instance:
CMAKE_ARGS="-DCMAKE_INSTALL_PREFIX=/opt/awesome" make ```sh
CMAKE_ARGS="-DCMAKE_INSTALL_PREFIX=/opt/awesome" make
```
### Installing current git master as a package receipts ### Installing current git master as a package receipts
#### Arch Linux AUR #### Arch Linux AUR
``` ```sh
sudo pacman -S --needed base-devel git sudo pacman -S --needed base-devel git
git clone https://aur.archlinux.org/awesome-git.git git clone https://aur.archlinux.org/awesome-git.git
cd awesome-git cd awesome-git
@ -44,7 +52,7 @@ makepkg -fsri
#### Debian-based #### Debian-based
``` ```sh
sudo apt build-dep awesome sudo apt build-dep awesome
git clone https://github.com/awesomewm/awesome git clone https://github.com/awesomewm/awesome
cd awesome cd awesome
@ -116,12 +124,16 @@ You can directly select Awesome from your display manager. If not, you can
add the following line to your `.xinitrc` to start Awesome using `startx` add the following line to your `.xinitrc` to start Awesome using `startx`
or to `.xsession` to start Awesome using your display manager: or to `.xsession` to start Awesome using your display manager:
exec awesome ```sh
exec awesome
```
In order to connect Awesome to a specific display, make sure that In order to connect Awesome to a specific display, make sure that
the `DISPLAY` environment variable is set correctly, e.g.: the `DISPLAY` environment variable is set correctly, e.g.:
DISPLAY=foo.bar:1 exec awesome ```sh
DISPLAY=foo.bar:1 exec awesome
```
(This will start Awesome on display `:1` of the host foo.bar.) (This will start Awesome on display `:1` of the host foo.bar.)
@ -145,12 +157,16 @@ problem.
You can call `awesome` with `gdb` like this: You can call `awesome` with `gdb` like this:
DISPLAY=:2 gdb awesome ```sh
DISPLAY=:2 gdb awesome
```
Then in `gdb` set any arguments and run it: Then in `gdb` set any arguments and run it:
(gdb) set args --replace ```
(gdb) run (gdb) set args --replace
(gdb) run
```
## Asking questions ## Asking questions