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.

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 updates #1282

Merged
merged 5 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
</div>
<br>

<b>An intuitive and customizable cross-platform ground control station for remote vehicles of all types. [Check it here](https://docs.bluerobotics.com/cockpit)</b>
**An intuitive and customizable cross-platform ground control station for remote vehicles of all types. [Click here for a demo!](https://docs.bluerobotics.com/cockpit)**

[![Test, Build and Deploy Images](https://github.com/bluerobotics/cockpit/actions/workflows/ci.yml/badge.svg)](https://github.com/bluerobotics/cockpit/actions/workflows/ci.yml)
![Downloads](https://img.shields.io/github/downloads/bluerobotics/cockpit/total?label=Downloads)
Expand All @@ -20,6 +20,10 @@
![Pulls](https://img.shields.io/docker/pulls/bluerobotics/cockpit?label=Pulls)
![Size](https://img.shields.io/docker/image-size/bluerobotics/cockpit?label=Size)](https://hub.docker.com/r/bluerobotics/cockpit/tags)

# Standard Usage

**See [our documentation](https://blueos.cloud/docs/extensions/cockpit/1.0/overview/)** 📖

# Development

## Installing Cockpit
Expand Down Expand Up @@ -79,4 +83,4 @@ Cockpit provides a simulation environments in a docker compose file. There is an
docker-compose -f sim.yml --profile ardusub up
```

Assuming you have run the `bun run dev --host` command, you can access the simulation environment by opening the browser and accessing `localhost:5173`.
Assuming you have run the `bun run dev --host` command, you can access the simulation environment by opening the browser and accessing `localhost:5173`.
Binary file modified public/images/screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading