diff --git a/README.md b/README.md index 5a825abec8..b4d84269a9 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,43 @@ -[![Accelerate your robotics development](https://user-images.githubusercontent.com/14011012/195918769-5aaeedf3-5de2-48fb-951e-7399f2b9e190.png)](https://foxglove.dev) -

Foxbox

- - - -
-
- Download -   •   - Docs -   •   - Blog -   •   - Slack -   •   - Twitter -   •   - Contact Us

-[Foxbox](https://foxglove.dev) is an integrated visualization and diagnosis tool for robotics, available [in your browser](https://studio.foxglove.dev/) or [as a desktop app](https://foxglove.dev/download) on Linux, Windows, and macOS. +Foxbox is an integrated visualization and diagnosis tool for robotics, available in your browser or as a desktop app on Linux, Windows, and macOS. Feel free to contribute with our discussions on the Mattermost Comunitty

- Foxbox screenshot + Foxbox screenshot

- -To learn more, visit the following resources: - -[About](https://foxglove.dev/about) - •  -[Documentation](https://docs.foxglove.dev/docs) - •  -[Release notes](https://github.com/foxglove/studio/releases) - •  -[Blog](https://foxglove.dev/blog) - -You can join us on the following platforms to ask questions, share feedback, and stay up to date on what our team is working on: - -[GitHub Discussions](https://github.com/orgs/foxglove/discussions) - •  -[Slack](https://foxglove.dev/slack) - •  -[Newsletter](https://foxglove.dev/#footer) - •  -[Twitter](https://twitter.com/foxglovedev) - •  -[LinkedIn](https://www.linkedin.com/company/foxglovedev/) -
## Installation -Foxbox is available online at [studio.foxglove.dev](https://studio.foxglove.dev/), or desktop releases can be downloaded from [foxglove.dev/download](https://foxglove.dev/download). - -## Open Source - -Foxbox follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE). - -The official binary distributions available at [studio.foxglove.dev](https://studio.foxglove.dev/) or [foxglove.dev/download](https://foxglove.dev/download) incorporate some closed-source functionality, such as integration with [Foxglove Data Platform](https://foxglove.dev/data-platform), multiple layouts, private extensions, and more. For more information on free and paid features, see our [Pricing](https://foxglove.dev/pricing). - -## Self-hosting - -Foxbox can be self-hosted using our [docker image](https://ghcr.io/foxglove/studio). Please note that this build does not contain any closed source functionality. +Foxbox is can be ran locally as a web application by using the command (also available on package.json) ```sh -docker run --rm -p "8080:8080" ghcr.io/foxglove/studio:latest +yarn run web:serve ``` Foxbox will be accessible in your browser at [localhost:8080](http://localhost:8080/). +It can also be installed by using the desktop aplication versions available on [github releases](https://github.com/bmw-software-engineering/foxbox/tags). -### Overriding the default layout +## Open Source -[Bind-mount](https://docs.docker.com/storage/bind-mounts/) a layout JSON file at `/foxglove/default-layout.json` to set the default layout used when loading Studio from the Docker image. +Foxbox follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE). -```sh -docker run --rm -p "8080:8080" -v /path/to/custom_layout.json:/foxglove/default-layout.json ghcr.io/foxglove/studio:latest -``` +The official binary distributions available at [studio.foxglove.dev](https://studio.foxglove.dev/) or [foxglove.dev/download](https://foxglove.dev/download) incorporate some closed-source functionality, such as integration with [Foxglove Data Platform](https://foxglove.dev/data-platform), multiple layouts, private extensions, and more. ## Contributing Foxbox is written in TypeScript – contributions are welcome! - -Note: All contributors must agree to our [Contributor License Agreement](https://github.com/foxglove/cla). See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. +Note: All contributors must agree to our Contributor License Agreement. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. ## Credits -Foxbox originally began as a fork of [Webviz](https://github.com/cruise-automation/webviz), an open source project developed by [Cruise](https://getcruise.com/). Most of the Webviz code has been rewritten, but some files still carry a Cruise license header where appropriate. +Foxbox originally began as a fork of [FoxGlove Studio](https://github.com/foxglove/studio), an open source project developed by [Foxglove](https://app.foxglove.dev/).