Skip to content

docs: add installation instructions #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chkpwd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add installation instructions #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,42 @@ Feel free to email comments, suggestions, or inquiries directly to andrewchilx@g
- An *'idle mode'* can be enabled to display the Lumon logo screensaver.
- The user can navigate the full grid using arrow and zoom keys.

## Install
```
# Clone Repository
git clone https://github.com/andrewchilicki/LumonMDR

# Install CMake
sudo apt install g++ cmake

# Create build directory and navigate to it
cd LumonMDR && \
mkdir build && cd build

# Generate build files and compile
cmake .. && make

# Copy LumonMDR and navigate back
cp LumonMDR .. && cd ..
```
> [!NOTE]
> See below, ff using a headless Pi with Raspbian LiteOS, you may require additional dependecies.

<details closed>
<summary>Installation Instructions (Debia/Ubuntu)</summary>

To install the required dependencies, run the following:

```bash
sudo apt-get install libglfw3-dev libglew-dev libxinerama-dev libxxf86vm-dev libxcursor-dev
```

Additionally, set the DISPLAY variable
```bash
export DISPLAY=:0
```
</details>

---
---

Expand Down