Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
complexlogic committed Dec 19, 2022
1 parent cbd2fcd commit 80ac520
Show file tree
Hide file tree
Showing 6 changed files with 352 additions and 159 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@ Unreleased
- Change application tracking to window focus-based instead of process based
- Remove OnLaunch "Hide" mode
- Reorganize configuration file into smaller sections
- Make VSync optional
- Add support for transparent backgrounds
- Allow control from multiple gamepads
- Allow unlimited number of slideshow backgrounds
- Make highlight optional
- Specify color with string beginning with # character
- Make application titles optional
- Specify color and key HEX codes with string beginning with # character
- Create dialog box on fatal errors
- Linux: Prefer native Wayland over XWayland

v1.8 (2022-10-7)
- Added inhibit OS screensaver feature
Expand Down
14 changes: 7 additions & 7 deletions docs/compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,40 @@ Flex Launcher on Linux builds with GCC. This guide assumes you already have the
First, install the dependencies. The steps to do so are dependent on your distro:

#### APT-based Distributions (Debian, Ubuntu, Mint, Raspberry Pi OS etc.)
```
```bash
sudo apt install libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
```

#### Pacman-based Distributions (Arch, Manjaro, etc.)
```
```bash
sudo pacman -S sdl2 sdl2_image sdl2_ttf
```

#### DNF-based Distributions (Fedora)
```
```bash
sudo dnf install SDL2-devel SDL2_image-devel SDL2_ttf-devel
```

### Building
Clone the master repo and create a build directory:
```
```bash
git clone https://github.com/complexlogic/flex-launcher.git
cd flex-launcher
mkdir build && cd build
```
Generate the Makefile:
```
```bash
cmake .. -DCMAKE_BUILD_TYPE=Release
```
If you're building on Raspberry Pi, it's recommended to pass `-DRPI=1` to cmake, which tweaks the default configuration to be more Pi-centric.

Build and test the program:
```
```bash
make
./flex-launcher
```
Optionally, install it into your system directories:
```
```bash
sudo make install
```
By default, this will install the program and assets with a prefix of `/usr/local`. If you wish to use a different prefix, re-run the cmake generation step with `-DCMAKE_INSTALL_PREFIX=prefix`.
Expand Down
Loading

0 comments on commit 80ac520

Please sign in to comment.