Matrix/API/deps/samples/README.md

## About

These are basic example scripts on the usage of the Matrix itself.

## Usage

Unfortunately, there is no known way to run the provided scripts as is due to the projects directory structure. However, you can still run the scripts with a little bit of a workaround:

1. Copy the directory `deps/samples/` to some other, well known place
2. Copy the file `deps/samplebase.py` into the `samples` copy you just created
3. Find and replace all references to the common library `samplebase.py`:

   - The erroneous imports should look like this:

     ```python
     from ..samplebase import SampleBase
     ```

   - And they should be replaced like this:

     ```python
     from samplebase import SampleBase
     ```

4. Run any given sample script with the following template:

   ```bash
   sudo python3 <script>.py
   ```

- **NOTE:** You may need to specify all kinds of different flags or arguments to run the matrix correctly. For usage, please refer to any of the scripts, followed by the flag `--help`

## Example Command

```bash
sudo python rotating-block-generator.py --led-rows=64 --led-cols=64 --led-slowdown-gpio=5 --led-parallel=3 --led-chain=3 --led-gpio-mapping=regular
```