Skip to content

Commit

Permalink
Added one line install
Browse files Browse the repository at this point in the history
  • Loading branch information
TheMariday committed Jul 14, 2024
1 parent 2a5a1d2 commit 052cda9
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ The basic algorithms behind this is what I used to map [Highbeam](https://www.yo

## Step 0: Install

Marimapper supports the following pre-built backends:
You can install Marimapper with just Python and Pip! No clone required!

For the Marimapper to communicate with your leds, it requires a backend.

Luckily, the following backends are pre-built:

- `fadecandy`
- [`wled`](https://kno.wled.ge/)
Expand All @@ -28,15 +32,18 @@ Marimapper supports the following pre-built backends:

To install Marimapper with a
`pixelblaze`
backend, download this repository and run
`pip install .[pixelblaze]`
backend, run the following command:

`pip install "marimapper[pixelblaze] @ git+http://github.com/themariday/marimapper"`

<details>
<summary>Using pixelblaze?</summary>
Using Pixelblaze as a backend requires you to upload the [`marimapper.epe`](marimapper/backends/pixelblaze/marimapper.epe) pattern to your pixelblaze before running Marimapper.
</details>

If you would like to write your own LED backend, just run `pip install .`
If you would like to write your own LED backend, run the following command:

`pip install "marimapper @ git+http://github.com/themariday/marimapper"`


## Step 1: Run the camera checker (recommended)
Expand Down

0 comments on commit 052cda9

Please sign in to comment.