-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with development instructions
- Loading branch information
Showing
1 changed file
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`. |