Update README with development instructions

bluerobotics · Jul 28, 2023 · e0fa30a · e0fa30a
1 parent 1b77a1c
commit e0fa30a
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
-# cockpit
+# Cockpit
+
 An intuitive and customizable cross-platform ground control station for remote vehicles of all types.
+
+# Development
+
+Cockpit is typically installed as an Electron application or BlueOS Extension, but for development purposes it is valuable to run it locally. To do so, you can install the dependencies with:
+
+```
+yarn install
+```
+
+and then run the server locally with:
+
+```
+yarn dev --host
+```
+
+Then you should see a prompt with the local IP and port that can be accessed through a browser, such as `localhost:5173`.