Skip to content

Commit

Permalink
Add a new gif & update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WheezyE committed Oct 9, 2022
1 parent 558bc21 commit e58ce35
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,34 @@ A [Winlink](http://winlink.org/) (RMS Express & VARA) installer Script for the R

_This project has lots of bugs and should be considered [alpha](https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha) software._

------------------------
![Winlink-Pi4](Winlink-Pi4.gif)
_RMS Express & VARA running on a Raspberry Pi 4B (RPiOS) [video sped-up]_

------------------------
![VARA-Pi4](VARA-Pi4.png "VARA running on a Raspberry Pi 4B (Twister OS)")
_VARA running on a Raspberry Pi 4B (Twister OS)_

------------------------

## Installation
Copy/paste these commands into your Raspberry Pi 4's terminal:
```bash
curl -O https://raw.githubusercontent.com/WheezyE/Winelink/main/install_winelink.sh && \
bash install_winelink.sh
```
- A full installation takes about 10 minutes (with user prompts)
- If desired, you can tell the script to only install VARA by running `curl -O https://raw.githubusercontent.com/WheezyE/Winelink/main/install_winelink.sh && bash install_winelink.sh vara_only`
###### _If desired, you can tell the script to only install VARA by running `curl -O https://raw.githubusercontent.com/WheezyE/Winelink/main/install_winelink.sh && bash install_winelink.sh vara_only`_

## Known issues
- ARDOP & VARA often have trouble connecting to RMS Express (over local TCP) when they first start up. Just restart them through RMS Express until they do connect (this is a bug in wine).
- VARA's CPU gauge doesn't display (this is a bug in wine).
- VARA doesn't connect to DRA boards at this time (this might be a bug in wine or box86).
- Enabling VARA HF's waterfall display can sometimes crash VARA & RMS Express.
- Using Monitor Mode in VARA can freeze VARA. (Users might have to delete their VARA config file to recover: `rm ~/.wine/drive_c/VARA/VARA.ini`)

- _RMS Express sometimes won't connect (over TCP) to ARDOP & VARA. Just close RMS Express and re-open it (this is a bug in wine)._
- _VARA's CPU gauge doesn't display (this is a bug in wine)._
- _VARA doesn't connect to DRA boards at this time (this might be a bug in wine or box86)._
- _Wine can sometimes freeze your OS completely if it gets overloaded. If this happens on a Raspberry Pi, you can SSH into the Pi and then run `wineserver -k` to force-quit Wine. You can also just power-off/on your system._
- _Enabling VARA HF's waterfall display can sometimes crash RMS Express & VARA._
- _Enabling VARA's Monitor Mode can freeze VARA. (Users might have to delete their VARA config file to recover: `rm ~/.wine/drive_c/VARA/VARA.ini`)_

## Credits
- [ptitSeb](https://github.com/ptitSeb/box86) for box86 debugging (& everyone on [the TwisterOS discord](https://discord.gg/Fh8sjmu))
- [ptitSeb](https://github.com/ptitSeb/box86) for box86 (& everyone on [the TwisterOS discord](https://discord.gg/Fh8sjmu))
> (ptitSeb, pale, chills340, Itai-Nelken, Heasterian, phoenixbyrd,
> monkaBlyat, lowspecman420, epychan, !FlameKat53, #lukefrenner,
> icecream95, SpacingBat3, Botspot, Icenowy, Longhorn, et.al.)
Expand Down Expand Up @@ -66,12 +73,12 @@ If you use this script in your project (or are inspired by it) just please be su
- [ ] Switch to using Seb's GitHub box86 binaries (or hosted box86 bins) instead of Pale's internet archive binaries.
- [ ] Help DRA-board compatability with VARA ([might be a box86 issue?](https://github.com/ptitSeb/box86/issues/567))
- [ ] Bisect box86 commits that crash VARA's local TCP to RMS connection (bug in newer box86's)
- [ ] Add updated example images.
- [ ] Consider adding a sed script to find/delete any small-value frequencies in `RMS Channels.dat` that would crash the HF Channel Selection Browser
- [ ] Clean up code with [Google style guide](https://google.github.io/styleguide/shellguide.html).
- [ ] Work with WineHQ to [figure out why VARA's CPU gauge isn't working](https://bugs.winehq.org/show_bug.cgi?id=50728).
- [ ] Work with WineHQ to [figure out why ARDOP & VARA don't always connect to RMS Express over TCP when first starting](https://bugs.winehq.org/show_bug.cgi?id=52521).
- [ ] Add progress bar (GUI?) for installation.
- [x] Add updated example images to readme.
- [x] Rely on [archive.org box86 binaries](https://archive.org/details/box86.7z_20200928) instead of compiling.
- [ ] Give user the choice to compile or not.
- [ ] Add auto-detection of failed downloads, then switch to compiling as contingency.
Expand Down
Binary file added docs/Winlink-Pi4.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e58ce35

Please sign in to comment.