From e0fa30acad874132abdf06a55c4bff817835bf95 Mon Sep 17 00:00:00 2001 From: Rustom Jehangir Date: Fri, 28 Jul 2023 09:17:19 -0700 Subject: [PATCH] Update README with development instructions --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84edeba87..c3c289ace 100644 --- 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`. \ No newline at end of file