55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
|
|
# PierMesh
|
|
## A new internet, a fresh start
|
|
|
|
This is the monorepo for PierMesh.
|
|
|
|
# Docs
|
|
|
|
<<<<<<< HEAD
|
|
<<<<<<< HEAD
|
|
You can find the full docs here: [docs/](https://git.utopic.work/PierMesh/piermesh/src/branch/main/docs)
|
|
=======
|
|
You can find the full docs here: [docs/](docs/)
|
|
>>>>>>> 3ad19a9 (Docs: Clean up primary readme)
|
|
=======
|
|
You can find the full docs here: [docs/](https://git.utopic.work/PierMesh/piermesh/src/branch/main/docs)
|
|
>>>>>>> 6f5bfe4 (Docs link fix)
|
|
|
|
# How to use
|
|
|
|
Note: these instructions will probably only work on Linux at the moment
|
|
|
|
Note: check the scripts to make sure they'll work with your system, and in general I recommend checking scripts before you run them
|
|
|
|
Follow Meshtastic's guide on setting up your device: [https://meshtastic.org/docs/getting-started/](https://meshtastic.org/docs/getting-started/)
|
|
Make sure you have the latest Python installed
|
|
|
|
```
|
|
git clone https://git.utopic.work/PierMesh/piermesh
|
|
|
|
cd piermesh
|
|
|
|
python -m venv .
|
|
|
|
source bin/activate
|
|
|
|
pip install -r requirements.txt
|
|
|
|
cd src
|
|
|
|
chmod a+x ./scripts/falin
|
|
|
|
./scripts/falin
|
|
```
|
|
|
|
# License text
|
|
|
|
```
|
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
|
|
```
|