Skip to content

Commit

Permalink
Update readme (#7534)
Browse files Browse the repository at this point in the history
  • Loading branch information
amacneil authored Mar 11, 2024
1 parent 684e5bc commit 56620d2
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 232 deletions.
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

9 changes: 0 additions & 9 deletions .github/pull_request_template.md

This file was deleted.

131 changes: 0 additions & 131 deletions .github/workflows/ci.yml

This file was deleted.

84 changes: 24 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,95 +2,59 @@

<br/>

> [!NOTE]
> Foxglove Studio 1.x is no longer supported. To install the latest release, please visit our [downloads page](https://foxglove.dev/download). Learn more in our [Foxglove 2.0 announcement](https://foxglove.dev/blog/foxglove-2-0-unifying-robotics-observability).
<div align="center">
<h1>Foxglove Studio</h1>
<a href="https://github.com/foxglove/studio/releases"><img src="https://img.shields.io/github/v/release/foxglove/studio?label=version" /></a>
<a href="https://github.com/foxglove/studio/blob/main/LICENSE"><img src="https://img.shields.io/github/license/foxglove/studio" /></a>
<a href="https://github.com/orgs/foxglove/discussions"><img src="https://img.shields.io/github/discussions/foxglove/community.svg?logo=github" /></a>
<a href="https://foxglove.dev/slack"><img src="https://img.shields.io/badge/chat-slack-purple.svg?logo=slack" /></a>
<br />
<br />
<a href="https://foxglove.dev/download">Download</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://docs.foxglove.dev/docs">Docs</a>
<a href="https://docs.foxglove.dev/">Docs</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://docs.foxglove.dev/changelog">Changelog</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://foxglove.dev/blog">Blog</a>
<a href="https://github.com/orgs/foxglove/discussions">Discussions</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://foxglove.dev/slack">Slack</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://twitter.com/foxglovedev">Twitter</a>
<a href="https://x.com/foxglove">X</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://foxglove.dev/contact">Contact Us</a>
<a href="https://www.linkedin.com/company/foxglovedev/">LinkedIn</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://foxglove.dev/contact">Contact</a>
<br />
<br />

[Foxglove](https://foxglove.dev) is an integrated visualization and diagnosis tool for robotics.
Foxglove is a visualization and observability platform for robotics development.

<p align="center">
<a href="https://foxglove.dev"><img alt="Foxglove Studio screenshot" src="/resources/screenshot.png"></a>
<a href="https://foxglove.dev"><img alt="Foxglove screenshot" src="/resources/screenshot.png"></a>
</p>
</div>

<hr />

To learn more, visit the following resources:

[About](https://foxglove.dev/about)
&nbsp;&nbsp;
[Documentation](https://docs.foxglove.dev/docs)
&nbsp;&nbsp;
[Release notes](https://github.com/foxglove/studio/releases)
&nbsp;&nbsp;
[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)
&nbsp;&nbsp;
[Slack](https://foxglove.dev/slack)
&nbsp;&nbsp;
[Newsletter](https://foxglove.dev/#footer)
&nbsp;&nbsp;
[Twitter](https://twitter.com/foxglovedev)
&nbsp;&nbsp;
[LinkedIn](https://www.linkedin.com/company/foxglovedev/)

<br />

## Installation

Foxglove Studio is available online at [app.foxglove.dev](https://app.foxglove.dev/), or desktop releases can be downloaded from [foxglove.dev/download](https://foxglove.dev/download).

## Open Source

Foxglove Studio 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 [app.foxglove.dev](https://app.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

Foxglove Studio 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.

```sh
docker run --rm -p "8080:8080" ghcr.io/foxglove/studio:latest
```

Foxglove Studio will be accessible in your browser at [localhost:8080](http://localhost:8080/).
[Create a free account](https://app.foxglove.dev/signup) or [download Foxglove](https://foxglove.dev/download) for Linux, Windows, or macOS to get started.

### Overriding the default layout
## Documentation

[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.
Documentation is hosted at [docs.foxglove.dev](https://docs.foxglove.dev/).

```sh
docker run --rm -p "8080:8080" -v /path/to/custom_layout.json:/foxglove/default-layout.json ghcr.io/foxglove/studio:latest
```
## Support

## Contributing
Support for Foxglove is available via the following channels:

Foxglove Studio is written in TypeScript – contributions are welcome!
- [GitHub Discussions](https://github.com/orgs/foxglove/discussions)
- [Foxglove Community Slack](https://foxglove.dev/slack)
- [Contact Us](https://foxglove.dev/contact)

Note: All contributors must agree to our [Contributor License Agreement](https://github.com/foxglove/cla). See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## License

## Credits
This project is availabile under the [Mozilla Public License v2.0](/LICENSE).

Foxglove Studio 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.
Foxglove is a trademark of Foxglove Technologies Inc.

0 comments on commit 56620d2

Please sign in to comment.