diff --git a/README.md b/README.md index 3f96e6ad811a2a625d7143acfe8c7a141b16d5fa..0da16dfb3ac94efdd95eb83b4596fe210e35234f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A simple clock that displays the current time in a fancy way. Use Wayland for the display server, especially if you're using an SPI display. X11 may also be too slow. +To install: ```bash cd ~ git clone https://git.rb9.xyz/TheJoeCoder/cs-fancy-clock @@ -17,10 +18,18 @@ python3 -m venv .venv # Install the requirements # Omit the -r requirements.neopixel.txt if you don't have a neopixel strip ./.venv/bin/pip install -r requirements.txt -r requirements.neopixel.txt +``` + +Then to run, run the pre-made script: +```bash +./run-pi.sh +``` + +Or, alternatively, you can run the commands manually. +```bash # Change access permissions for Wayland (insecure but necessary) -xhost +SI:localuser:root +xhost + # Run the clock sudo ./.venv/bin/python3 main.py - -``` \ No newline at end of file +```