You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-7Lines changed: 18 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,12 +49,28 @@ Either use the executable from the release assets or run the program with `pytho
49
49
50
50
### From Executables
51
51
52
-
Use the executable from the release assets on Github. No packages will need to be installed and no source code needs to be downloaded.
52
+
Use the executable from the release assets on Github. No packages will need to be installed and no source code needs to be downloaded. However you will need to unzip the archive before running the executable.
53
53
54
54
- MacOs supports arm architecture
55
55
- Linux supports ubuntu 24 with arm and amd64 architecture as well as ubuntu 22 with amd64 architecture
56
56
- Windows supports windows amd64 and arm64 architecture
57
57
58
+
#### First run notes
59
+
Operating systems may block downloaded executables until you explicitly allow them.
60
+
61
+
-`Windows`: If SmartScreen appears, use `More info` then `Run anyway`. If needed, in power shell unblock the extracted files `Get-ChildItem .\SerialUI -Recurse -File | Unblock-File`
62
+
-`macOS`: If Gatekeeper blocks launch, right-click the app and choose `Open` once. If still blocked, remove quarantine recursively in shell:
-`Linux`: After unzip, ensure executable bit is set in shell:
65
+
`chmod +x ./SerialUI/SerialUI`
66
+
67
+
After first launch, you can run self-tests from a terminal to make sure the accelerators work:
68
+
69
+
- C parser: `SerialUI --selftest-c-parser`
70
+
- Numba acceleration: `SerialUI --selftest-numba`
71
+
- If self-tests fail, SerialUI still runs and falls back to the pure Python version.
72
+
- Windows ARM64 builds do not currently enable numba acceleration (llvmlite wheel availability).
73
+
58
74
### From Source
59
75
60
76
Clone this repository into a folder where you store python programs and install the packages described below.
@@ -65,12 +81,7 @@ This program has dependencies. You can install them with `scripts/setup.sh` on L
65
81
66
82
There is build script in `scripts/release.sh` or `release.ps1` to activate the C accelerated text parser with `./scripts/release.sh --build-c-accelerated` or `./scripts/release.ps1 -build-c-accelerated`
67
83
68
-
This requires a Cpp compiler and the python packages `pybind11` and `setuptools` to be available.
69
-
70
-
A future version will also need:
71
-
-`scipy` image decompression (FFT)
72
-
-`cobs` serial data encoding (byte stuffing)
73
-
-`tamp` for compression (lightweight for microcontrollers)
84
+
This requires a C++ compiler and the python packages `pybind11` and `setuptools` to be available.
0 commit comments