Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Add instructions on cloning with submodules #622

Merged
merged 3 commits into from
Dec 8, 2023
Merged

README: Add instructions on cloning with submodules #622

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15e801c
README: Add instructions on cloning with submodules
rafaellehmkuhl Dec 5, 2023
3f3ef5c
Update README.md
rafaellehmkuhl Dec 8, 2023
da0fdbd
Update README.md
rafaellehmkuhl Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ An intuitive and customizable cross-platform ground control station for remote v
## Installing Cockpit
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 should first [install bun](https://bun.sh/docs/installation). We really recomend following their documented instructions, as it was already reported by some that installing `bun` from alternatives like Snap has not worked properly.
First of all, you need to clone the repository and it's submodules. Don't forget to clone the submodules as they are needed for Cockpit to run:
rafaellehmkuhl marked this conversation as resolved.
Show resolved Hide resolved

```
git clone --recurse-submodules [email protected]:bluerobotics/cockpit.git
```

After that you should [install bun](https://bun.sh/docs/installation). We really recomend following their documented instructions, as it was already reported by some that installing `bun` from alternatives like Snap has not worked properly.
rafaellehmkuhl marked this conversation as resolved.
Show resolved Hide resolved

With `bun` installed, you can enter the repository folder and follow the steps below:

Expand Down