Skip to content

Commit

Permalink
docs: add systemd-run ability for startup apps + updated build instru…
Browse files Browse the repository at this point in the history
…ctions
  • Loading branch information
mattkae committed Sep 7, 2024
1 parent 23ca746 commit bb54fa1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/configuration/startup_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ A list of:

# If true, the application will automatically restart
- restart_on_death: bool

# If true, the application will be started with "systemd-run --user --property Restart=on-failure <COMMAND>"
- in_systemd_scope: bool
```
## Example
Expand All @@ -26,4 +29,5 @@ startup_apps:
restart_on_death: true
- command: swaybg -i /path/to/my/image
restart_on_death: true
in_systemd_scoipe: true
```
21 changes: 19 additions & 2 deletions docs/getting_started/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,43 @@
- [cmake](https://cmake.org/) >= 3.7
- [gcc](https://gcc.gnu.org/) or [clang](https://clang.llvm.org/) with C++23 support
- [miral](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 7
- [miroil](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/)
- [mirrenderer](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/)
- [mirwayland](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/)
- [mirserver](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/)
- [mirserver-internal](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/)
- [mir-graphics-drivers-desktop](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 2.14
- [mir-graphics-drivers-nvidia](https://canonical-mir.readthedocs-hosted.com/stable/getting_and_using_mir/) >= 2.14 (NVIDIA Only)
- [glib-2.0](https://docs.gtk.org/glib/)
- [yaml-cpp](https://github.com/jbeder/yaml-cpp)
- [libevdev](https://www.freedesktop.org/wiki/Software/libevdev/)
- [nlohmann json](https://github.com/nlohmann/json) >= 3.2.0
- [libnotify](https://gitlab.gnome.org/GNOME/libnotify)
- [libxkbcommon-devel](https://github.com/xkbcommon/libxkbcommon)
- [libxkbcommon](https://github.com/xkbcommon/libxkbcommon)
- [libgles2-mesa-dev](https://docs.mesa3d.org/opengles.html)
- [json-c](https://github.com/json-c/json-c) >= 0.17


## From source
```sh
git clone https://github.com/mattkae/miracle-wm.git
git clone https://github.com/miracle-window-manager/miracle-wm.git
cd miracle-wm

cmake -Bbuild
cmake --build build
WAYLAND_DISPLAY=wayland-98 ./build/bin/miracle-wm
```

### CMake Options
The following options are available at build time:

- `-DSNAP_BUILD`: Informs cmake that this is being built for a snap
since some parameters need to be tweaked for that use case.
- `-DSYSTEMD_INTEGRATION`: If enabled, miracle will build with full
systemd integration, including establishing a user session and
importing the proper environment variables in to systemd.


## Snap
```sh
cd miracle-wm
Expand Down

0 comments on commit bb54fa1

Please sign in to comment.