Skip to content

Commit

Permalink
Docs. (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
ATATC committed Feb 9, 2024
1 parent 0c39d4a commit 66443f0
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,23 @@ systemctl daemon-reload
systemctl enable leads_vec_rc
```

### Configurations
## Environment Setup

The configuration is a json file that has the following columns. You can have an empty configuration file like the following as all the columns are optional.
This section helps you set up the exact environment we have for the VeC project. A more detailed guide of reproduction is available on [https://leads.projectneura.org](https://leads.projectneura.org), but first of all, we run an Ubuntu 22.04 LTS on a Raspberry Pi 4 Model B 8GB. After the OS is set up, clone the repository or download the scripts from [releases](releases) (only stable releases provide scripts).

You can simply run "[setup.sh](scripts/setup.sh)" and it will install everything for you. If anything goes wrong, you can also manually install everything.

If you install Python using the scripts, you will not find `python ...`, `python3 ...`, `pip ...`, or `pip3 ...` working because you have to specify the Python version such that `python3.11 ...` and `python3.11 -m pip ...`.

## Configurations

The configuration is a JSON file that has the following columns. You can have an empty configuration file like the following as all the columns are optional.

```json
{}
```

Note that a purely empty file could cause error.
Note that a purely empty file could cause an error.

| | Type | Usage | Used By | Default |
| ------------------------- | ------- | ------------------------------------------------------------ | ------------ | ------------- |
Expand Down
3 changes: 2 additions & 1 deletion scripts/python-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ fi
sudo su
apt update
apt install python3.11
apt install python3-rpi.gpio
apt install python3-tk
apt install python3-rpi.gpi
8 changes: 8 additions & 0 deletions scripts/setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
if ! sudo -v &>/dev/null;
then
echo "Error: This script requires root permission"
exit 1
fi
sudo su
./python-install.sh
python3.11 -m pip install pysimplegui keyboard RPi.GPIO pyserial leads

0 comments on commit 66443f0

Please sign in to comment.