Minor fixes to make it build from a clean slate.

oddhack · Jan 2, 2024 · 2757c53 · 2757c53
1 parent d082c5f
commit 2757c53
Showing 1 changed file with 38 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -16,22 +16,54 @@ for existing and planned features.
 
 ### To configure
 
-```bash
-cmake -B build/ -DCMAKE_INSTALL_PREFIX="${HOME}/.local"
+Some of Wayland Maker's core dependencies are also in development and are a
+moving target, hence these are referred to as git submodules. Build and install
+these first (default to `${HOME}/.local`):
+
+``` bash
+git submodule update --init --checkout --recursive --merge
+(cd dependencies &&
+ LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
+ PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
+ cmake -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/.local -B build &&
+ cd build &&
+ LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
+ PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
+ make)
 ```
 
-### To build
+With the dependencies installed, proceed to configure wlmaker:
 
 ```bash
-(cd build && make)
+LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
+PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
+cmake -DCMAKE_INSTALL_PREFIX="${HOME}/.local" -B build/
+```
+
+### To build and install
+
+``` bash
+(cd build && \
+ LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
+ PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
+ make && \
+ make install)
 ```
 
-### To install
+### To run it
+
+Since `wlmaker` is in early development, it's not recommended to use it as your
+primary compositor. It should run fine in it's own window, though:
 
 ```bash
-(cd build && make install)
+LD_LIBRARY_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)" \
+PKG_CONFIG_PATH="${HOME}/.local/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH)/pkgconfig/:${HOME}/.local/share/pkgconfig/" \
+${HOME}/.local/bin/wlmaker
 ```
 
+Press `ctrl+window+alt T` to open a Terminal (`foot`), and `ctrl-window-alt Q`
+to exit.
+
 ## Contributing
 
 See [`CONTRIBUTING.md`](CONTRIBUTING.md) for details, and