Skip to content

Commit 1f0d5d0

Browse files
committed
restructure README with installation instructions
1 parent a0f7219 commit 1f0d5d0

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,43 @@ using [egui](https://github.com/emilk/egui).
77
Inspired by the serial monitor/plotter from the Arduino IDE, but both plotting and reading the traffic can be done
88
simultaneously.
99

10+
## Installation:
11+
12+
### Download pre-built executables
13+
1014
[Binary bundles](https://github.com/hacknus/serial-monitor-rust/releases) are available for Linux, macOS and Windows.
1115

1216
Running the apple silicon binary may result to the message "Serial Monitor is damaged and cannot be opened.", to get
1317
around this you first need to run:
1418
`xattr -rd com.apple.quarantine Serial\ Monitor.app`
1519

16-
Features:
20+
On Linux first install the following:
21+
22+
```sh
23+
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
24+
```
25+
26+
### Compile from source
27+
28+
The source code can be run using ```cargo run``` or bundled to a platform-executable using cargo bundle.
29+
Currently [cargo bundle](https://github.com/burtonageo/cargo-bundle) only supports linux and macOS
30+
bundles [see github issue](https://github.com/burtonageo/cargo-bundle/issues/77).
31+
As a work-around we can use [cargo wix](https://github.com/volks73/cargo-wix) to create a windows installer.
32+
33+
On Linux first install the following:
34+
35+
```sh
36+
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
37+
```
38+
39+
After downloading
40+
```cargo install cargo-bundle``` or ```cargo install cargo-wix```
41+
run
42+
```cargo bundle``` or ```cargo wix``` to create platform-executable bundles.
43+
44+
It can be compiled and run on all platforms.
45+
46+
## Features:
1747

1848
- [X] Plotting and printing of data simultaneously
1949
- [X] Smart data parser, works with ", " or "," or ":" or ": "
@@ -43,18 +73,6 @@ Features:
4373

4474
![Screenshot of the application on macOS](screenshot.png)
4575

46-
The source code can be run using ```cargo run``` or bundled to a platform-executable using cargo bundle.
47-
Currently [cargo bundle](https://github.com/burtonageo/cargo-bundle) only supports linux and macOS
48-
bundles [see github issue](https://github.com/burtonageo/cargo-bundle/issues/77).
49-
As a work-around we can use [cargo wix](https://github.com/volks73/cargo-wix) to create a windows installer.
50-
51-
After downloading
52-
```cargo install cargo-bundle``` or ```cargo install cargo-wix```
53-
run
54-
```cargo bundle``` or ```cargo wix``` to create platform-executable bundles.
55-
56-
It can be compiled and run on all platforms.
57-
5876
Tested on:
5977

6078
- macOS 12 Monterey x86
@@ -65,10 +83,4 @@ Tested on:
6583
- Windows 10 x86
6684
- ...
6785

68-
On Linux first install the following:
69-
70-
```sh
71-
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
72-
```
73-
7486
One might have to delete the ```Cargo.lock``` file before compiling.

0 commit comments

Comments
 (0)