diff --git a/API/deps/samples/README.md b/API/deps/samples/README.md new file mode 100644 index 0000000..f04ad7d --- /dev/null +++ b/API/deps/samples/README.md @@ -0,0 +1,37 @@ +## 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