Skip to content

Commit fdda88a

Browse files
committed
update README
1 parent 3f6944a commit fdda88a

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# RioLogManager
2+
3+
A lightweight PyQt6 application designed for FRC teams to quickly synchronize and manage logs from a RoboRIO.
4+
5+
![App Screenshot](app.png)
6+
7+
## Features
8+
- **Real-time Monitoring:** Tracks RoboRIO disk usage and connection status.
9+
- **Fast Sync:** Pulls logs from \`/home/lvuser/akitlogs\` via SFTP.
10+
- **Auto-Cleanup:** Option to delete logs from the RIO after a successful sync.
11+
- **Dark Mode:** Support for both light and dark UI themes.
12+
13+
## Installation
14+
Download the latest version for your operating system from the [Releases](https://github.com/Ihlathi/RioLogManager/releases) page.
15+
16+
### macOS
17+
1. Download the \`RioLogManager-macOS.zip\`.
18+
2. Extract the application and move it to your \`Applications\` folder (if you would like).
19+
3. When you open it for the first time, MacOS will complain about it not being signed. You can override this at the bottom of System Settings/Privacy & Security. **Open**.
20+
21+
### Windows
22+
1. Download \`RioLogManager-Windows.exe\`.
23+
2. Run the executable directly; no installation required.
24+
2. Windows will complain about the app not being signed—you'll have to override this.
25+
26+
## Usage
27+
Once launched, ensure you are connected to the robot radio or via USB-B.
28+
29+
### Configuration
30+
Access the **Preferences** menu to set:
31+
- **RoboRIO IP:** Defaults to \`10.6.19.2\`.
32+
- **Save Location:** Local directory where logs will be stored.
33+
- **Dark Mode:** Toggle UI appearance.

app.png

420 KB
Loading

0 commit comments

Comments
 (0)