Serving Docs Locally for Development
Some things won't display properly like logos or protobufs page, this is not cause for concern.
In order to set up your local environment, you will need to install:
Fork the Meshtastic Repository
Log into GitHub and create a fork of the meshtastic/meshtastic repository.
Clone your Meshtastic Repository fork
username with your GitHub username.
git clone https://github.com/username/meshtastic.git
Change directory to Local copy
Run Development Server
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
Update Local Repository
Verify Upstream Remote is Set
git remote -v
If it's set, skip to Align with meshtastic/meshtastic Master branch
Update/Set Upstream if it isn't configured properly
If upstream exists, set the URL:
git remote set-url upstream https://github.com/meshtastic/meshtastic.git
If upstream doesn't exist, add the URL:
git remote add upstream https://github.com/meshtastic/meshtastic.git
Align with meshtastic/meshtastic Master branch
This will delete any unfinished work. Make sure that you've saved and committed any work you wish to push up to your fork.
The following command assumes the clone of your Meshtastic fork is in the home directory (
~/meshtastic). Adjust the path to the correct path on your machine.
cd ~/meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master