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

Added submodule clone command to pull in design repo (#1444)
Some checks are pending
CI / quality (push) Waiting to run
Details
CI / build (push) Waiting to run
Details

Browse source
This commit is contained in:
Adam McQuilkin 2024-09-11 16:00:11 -07:00 committed by GitHub
parent 97da7c523d
commit 84badc3ab6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/development/documentation/local-dev.mdx
View file

@ -4,10 +4,6 @@ title: Serving Docs Locally for Development
sidebar_label: Local Development sidebar_label: Local Development
--- ---
:::note
Some things won't display properly like logos or protobufs page, this is not cause for concern.
:::
## Prerequisites ## Prerequisites
In order to set up your local environment, you will need to install: In order to set up your local environment, you will need to install:
@ -24,17 +20,23 @@ Log into GitHub and create a fork of the [meshtastic/meshtastic](https://github.
### Clone your Meshtastic Repository fork ### Clone your Meshtastic Repository fork
:::note :::note
Replace `username` with your GitHub username. Replace `YOUR_GITHUB_USERNAME` with your GitHub username.
::: :::
```shell title="Clone username/Meshtastic Repo" ```shell title="Clone your Fork of the Documentation Repository"
git clone https://github.com/username/meshtastic.git git clone https://github.com/YOUR_GITHUB_USERNAME/meshtastic.git
``` ```
### Change directory to Local copy ### Change directory into your Local Copy
```shell title="Change Directory" ```shell title="Change Directory"
cd ~/meshtastic cd ./meshtastic
```
### Install Submodules
```shell title="Install Submodules"
git submodule update --init --recursive
``` ```
### Install Dependencies ### Install Dependencies