mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-21 03:25:51 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

initial instructions

Browse source
This commit is contained in:
Foster Irwin 2022-02-22 13:35:03 -07:00
parent 9ec01c99f7
commit a73b7a298e
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/developers/maintaining-documentation/serve-docs-locally.md
View file

@ -49,3 +49,35 @@ Before submitting a pull request, it's helpful to run the following command to e
yarn build
```
:::
## Update Local Repository
### Verify Upstream Remote is Set
```bash title="Check Remote and Upstream Repositories"
git remote -v
```
If it's set, skip to [Align with meshtastic/Meshtastic Master branch](#align-with-meshtasticmeshtastic-master-branch)
#### Update/Set Upstream if it isn't configured properly
If upstream exists, set the url:
```bash title="Update Upstream Repository"
git remote set-url upstream https://github.com/meshtastic/Meshtastic.git
```
If upstream doesn't exist, add the url:
```bash title="Add Upstream Repository"
git remote add upstream https://github.com/meshtastic/Meshtastic.git
```
### Align with meshtastic/Meshtastic Master branch
:::caution
This will delete any unfinished work. Make sure that you've saved and committed any work you wish to push up to your fork.
:::
:::info
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.
:::
```bash title="Rebase local Meshtastic to remote Meshtastic"
cd ~/Meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master
```