mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-24 21:24:44 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update repobeats link & repo url's

Browse source
This commit is contained in:
Sacha Weatherstone 2022-10-31 18:53:15 +10:00
parent 6255cd1fc5
commit 848987cffa
No known key found for this signature in database
GPG key ID: 7AB2D7E206124B31
4 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -11,7 +11,7 @@ Website and documentation source for the Meshtastic project.
## Stats
![Alt](https://repobeats.axiom.co/api/embed/e6da6ff0a9523a4eee6931d675dfeefdb7ca8692.svg "Repobeats analytics image")
![Alt](https://repobeats.axiom.co/api/embed/9ef7282debe009789c697432a86499ac2b058a86.svg 'Repobeats analytics image')
## Development & Building

2
docs/developers/contributing.mdx
View file

@ -58,4 +58,4 @@ There are two phone apps that interact with the Meshtastic devices:
## Documentation
This website is in the [Meshtastic](https://github.com/meshtastic/Meshtastic) repository.
This website is in the [Meshtastic](https://github.com/meshtastic/meshtastic) repository.

6
docs/developers/documentation/index.mdx
View file

@ -33,14 +33,14 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for
Assuming you have the [prerequisites installed](serve-docs-locally#prerequisites), running a local instance of Docusaurus takes three steps:
1. Fork/Clone the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository and navigate to the root directory of the project.
1. Fork/Clone the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository and navigate to the root directory of the project.
```shell title="Clone the project"
git clone https://github.com/meshtastic/Meshtastic.git
git clone https://github.com/meshtastic/meshtastic.git
```
```shell title="Clone fork of the project"
git clone https://github.com/[username]/Meshtastic.git
git clone https://github.com/[username]/meshtastic.git
```
```shell title="Change Directory"

14
docs/developers/documentation/serve-docs-locally.mdx
View file

@ -19,7 +19,7 @@ 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](https://github.com/meshtastic/Meshtastic) repository.
Log into Github and create a fork of the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository.
### Clone your Meshtastic Repository fork
@ -66,32 +66,32 @@ yarn build
git remote -v
```
If it's set, skip to [Align with meshtastic/Meshtastic Master branch](#align-with-meshtasticmeshtastic-master-branch)
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:
```shell title="Update Upstream Repository"
git remote set-url upstream https://github.com/meshtastic/Meshtastic.git
git remote set-url upstream https://github.com/meshtastic/meshtastic.git
```
If upstream doesn't exist, add the url:
```shell title="Add Upstream Repository"
git remote add upstream https://github.com/meshtastic/Meshtastic.git
git remote add upstream https://github.com/meshtastic/meshtastic.git
```
### Align with meshtastic/Meshtastic Master branch
### 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.
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.
:::
```shell title="Rebase local Meshtastic to remote Meshtastic"
cd ~/Meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master
cd ~/meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master
```