Skip to content

Commit f8766e6

Browse files
authored
Update README.md
1 parent 4a8a88d commit f8766e6

File tree

1 file changed

+1
-58
lines changed

1 file changed

+1
-58
lines changed

README.md

Lines changed: 1 addition & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1 @@
1-
# ohmyoled
2-
3-
# Prerequistes:
4-
5-
Download the binary and support files
6-
Go to releases and download the most recent tag
7-
```
8-
wget https://github.com/TheFinalJoke/ohmyoled/releases/download/$tag/ohmyoled-$tag.tar.gz
9-
```
10-
Uncompress the File
11-
```
12-
tar -zxvf ohmyoled-$tag.tar.gz
13-
```
14-
Run the Install Script
15-
```
16-
#!/bin/bash
17-
cd ohmyoled-$tag
18-
chmod 755 install.sh
19-
sudo ./install.sh
20-
```
21-
22-
# Run The Script
23-
24-
```
25-
sudo systemctl enable --now ohmyoled.service
26-
```
27-
28-
# Configuration
29-
This is the Basic of Linux Configuration Files located /etc/ohmyoled/ohmyoled.conf
30-
31-
Run Different Modules Set the Modules Run Attribute to True
32-
33-
*Note: Most needs to have API Tokens assoicated to The Module
34-
* You will also need to Reload The service after any changes
35-
36-
```
37-
[weather]
38-
Run=True
39-
```
40-
41-
You Can also change different Configurations like weather
42-
You can add different zipcode/city
43-
44-
# To Help Write Our and use tests
45-
```
46-
pip install -e .[dev]
47-
```
48-
49-
# Development
50-
Open vscode and make sure you have docker on your raspberry pi
51-
Then connect to remote raspberry pi or run vscode on raspberry pi
52-
Choose to reopen in container and you will have the environment to develop
53-
54-
# Soon To come: Docker Container
55-
# Known Problems
56-
57-
// If your pi is not booting, you will have to change the kernel bootloader. With Raspbain OS the bootloader is borked with HAT Software
58-
https://learn.adafruit.com/adafruit-1-3-color-tft-bonnet-for-raspberry-pi/kernel-module-troubleshooting
1+
# All Information is here in the wiki: https://github.com/TheFinalJoke/ohmyoled/wiki

0 commit comments

Comments
 (0)