Skip to content

Commit

Permalink
Updated README.md & CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoradocchia committed Jun 14, 2022
1 parent 5582fa9 commit 66b7962
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
12 changes: 8 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# [0.2.0] - 2022-06-13
# [0.2.0] - 2022-06-14

Updated
[README](https://github.com/marcoradocchia/bombuscv-rs/blob/master/README.md)
*Usage* and *Configuration* sections.
*Examples*, *Usage* and *Configuration* sections.

## Changed

- Updated `bombuscv-raspi.sh` script to install **OpenCV** `v4.6.0`.

## Fixed

Issue marcoradocchia/bombuscv-rs#1 which prevented `bombuscv` to autodetect
video framerate and resolution on `video` CLI option used.
- Issue marcoradocchia/bombuscv-rs#1 which prevented `bombuscv` to autodetect
video framerate and resolution on `video` CLI option used.

## Removed

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,13 @@ order to install it run `cargo install bombuscv-rs` in your shell.

### Install on RaspberryPi 4

It is strongly recommended to use a RaspberryPi with at least 4GB of RAM.
Since installation on a RaspberryPi may be a little bit *tricky*, an
installation script is provided[^4]. It takes care of updating & preparing the
system, compiling *OpenCV* and installing *Rustup* and finally
**BombusCV**. You can run the [instllation script](bombuscv-raspi.sh) using
`curl`:
It is strongly recommended to use a RaspberryPi with at least 4GB of RAM. Also,
before trying to install, please enable *Legacy Camera* support under
*Interface options* running `raspi-config` and reboot. Since installation on
a RaspberryPi may be a little bit *tricky*, an installation script is
provided[^4]. It takes care of updating & preparing the system, compiling
*OpenCV* and installing *Rustup* and finally **BombusCV**. You can run the
[instllation script](bombuscv-raspi.sh) using `curl`:
```sh
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/marcoradocchia/bombuscv-rs/master/bombuscv-raspi.sh | sh
```
Expand Down Expand Up @@ -161,7 +162,7 @@ Complete [CHANGELOG](CHANGELOG.md).

## ToDo

- [ ] Provide build & install instructions in [README](README.md), as well as
- [x] Provide build & install instructions in [README](README.md), as well as
the instructions to install OpenCV.
- [x] Make install script for automated installation on RaspberryPi.
- [x] Passing `video` or `directory` options in the configuration file using
Expand Down

0 comments on commit 66b7962

Please sign in to comment.