Skip to content

Commit

Permalink
restructure README with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hacknus committed Dec 22, 2024
1 parent a0f7219 commit 1f0d5d0
Showing 1 changed file with 31 additions and 19 deletions.
50 changes: 31 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,43 @@ using [egui](https://github.com/emilk/egui).
Inspired by the serial monitor/plotter from the Arduino IDE, but both plotting and reading the traffic can be done
simultaneously.

## Installation:

### Download pre-built executables

[Binary bundles](https://github.com/hacknus/serial-monitor-rust/releases) are available for Linux, macOS and Windows.

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

Features:
On Linux first install the following:

```sh
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
```

### Compile from source

The source code can be run using ```cargo run``` or bundled to a platform-executable using cargo bundle.
Currently [cargo bundle](https://github.com/burtonageo/cargo-bundle) only supports linux and macOS
bundles [see github issue](https://github.com/burtonageo/cargo-bundle/issues/77).
As a work-around we can use [cargo wix](https://github.com/volks73/cargo-wix) to create a windows installer.

On Linux first install the following:

```sh
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
```

After downloading
```cargo install cargo-bundle``` or ```cargo install cargo-wix```
run
```cargo bundle``` or ```cargo wix``` to create platform-executable bundles.

It can be compiled and run on all platforms.

## Features:

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

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

The source code can be run using ```cargo run``` or bundled to a platform-executable using cargo bundle.
Currently [cargo bundle](https://github.com/burtonageo/cargo-bundle) only supports linux and macOS
bundles [see github issue](https://github.com/burtonageo/cargo-bundle/issues/77).
As a work-around we can use [cargo wix](https://github.com/volks73/cargo-wix) to create a windows installer.

After downloading
```cargo install cargo-bundle``` or ```cargo install cargo-wix```
run
```cargo bundle``` or ```cargo wix``` to create platform-executable bundles.

It can be compiled and run on all platforms.

Tested on:

- macOS 12 Monterey x86
Expand All @@ -65,10 +83,4 @@ Tested on:
- Windows 10 x86
- ...

On Linux first install the following:

```sh
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
```

One might have to delete the ```Cargo.lock``` file before compiling.

0 comments on commit 1f0d5d0

Please sign in to comment.