mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

README.md - Move development instructions to site link

Browse source
This commit is contained in:
James 2024-02-09 21:58:44 -07:00 committed by GitHub
parent 8568c9b628
commit 3219b76596
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -15,24 +15,6 @@ Website and documentation source for the Meshtastic project.
## Development & Building
_nodejs_ is required in your dev. environment. The method for installing _nodejs_ depends on your operating system. This software is built using [Docusaurus](https://docusaurus.io).
For complete instructions on setting up your development environment and for building and running the project locally, please refer to our [Local Development Guide](https://meshtastic.org/docs/development/documentation/local-dev/).
Before installing dependencies, make sure you have _pnpm_ installed. Follow the documentation at [pnpm installation guide](https://pnpm.io/installation) to install _pnpm_ if you haven't already.
Go to the root directory of your repository and install dependencies:
```shell
pnpm install
```
Build the project with the following command
```shell
pnpm build
```
Start a local dev. instance with the following command
```shell
pnpm start
```
Our guide provides all the necessary steps to contribute to the Meshtastic project effectively.