mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 21:54:20 -08:00

Meshtastic project website and documentation

Find a file

Sacha Weatherstone ea6c08bde7 Update README.md		2023-01-02 16:46:01 +11:00
.github	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
docs	fix missing notation	2023-01-02 14:57:48 +11:00
protobufs@b4677e35ca	update downloads page & deps	2022-12-10 16:54:44 +10:00
scripts	revamp refinements	2022-11-03 20:10:08 -04:00
src	Update deps and 2.0 page	2022-12-28 18:02:41 +11:00
static	update obtainium to include search, add github img	2022-12-14 19:50:21 -07:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.eslintrc	add eslint config	2022-09-21 19:33:07 +10:00
.gitignore	updates to various pages (#487 )	2022-11-02 09:31:54 +11:00
.gitmodules	Repo updates	2022-10-31 18:31:16 +10:00
.prettierrc	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
docusaurus.config.js	added custom color scheme	2022-12-30 14:01:56 -07:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Update readme template & update deps	2023-01-02 14:53:04 +11:00
pnpm-lock.yaml	Update readme template & update deps	2023-01-02 14:53:04 +11:00
protobuf.tmpl	fixed protobuf api links	2022-11-03 22:24:31 -04:00
README.md	Update README.md	2023-01-02 16:46:01 +11:00
sidebars.js	Developers, Developers, Developers	2022-06-30 08:48:30 -07:00
tailwind.config.cjs	Hardware page improvements	2022-04-03 00:57:31 +11:00
tsconfig.json	Update dependencies	2022-05-07 23:51:02 +10:00

README.md

Meshtastic

Overview

Website and documentation source for the Meshtastic project.

Stats

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.

Go to the root directory of your repository and install dependencies:

pnpm install

Build the project with the following command

pnpm build

Start a local dev. instance with the following command

pnpm start