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

Update readme and name generated on desktop app #12

Merged
merged 4 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Foxglove Studio
# Contributing to Foxbox

**Supported development environments:** Linux, Windows, macOS

Expand Down Expand Up @@ -42,7 +42,7 @@ $ yarn test:watch # run tests on changed files

## Localization

At this time, first-class support for Foxglove Studio is provided in English only. Localization into other languages is available on a best-effort basis, with translations provided by community volunteers. Current community supported-languages are:
At this time, first-class support for Foxbox is provided in English only. Localization into other languages is available on a best-effort basis, with translations provided by community volunteers. Current community supported-languages are:

- Chinese
- Japanese
Expand All @@ -56,7 +56,7 @@ Translation support is implemented using [`react-i18next`](https://react.i18next

### Add translations to the `i18n` directory

The [`i18n` directory](packages/studio-base/src/i18n) contains translated (localized) strings for all languages supported by Foxglove Studio.
The [`i18n` directory](packages/studio-base/src/i18n) contains translated (localized) strings for all languages supported by Foxbox.

Translated strings are organized into _namespaces_ — e.g. [`i18n/[language]/appSettings.ts`](packages/studio-base/src/i18n/en/appSettings.ts) contains translations for the app's Settings tab.

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<br/>

<div align="center">
<h1>Foxglove Studio</h1>
<h1>Foxbox</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>
Expand All @@ -24,10 +24,10 @@
<br />
<br />

[Foxglove Studio](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](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.

<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="Foxbox screenshot" src="/resources/screenshot.png"></a>
</p>
</div>

Expand Down Expand Up @@ -59,23 +59,23 @@ You can join us on the following platforms to ask questions, share feedback, and

## Installation

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

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).
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

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

```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/).
Foxbox will be accessible in your browser at [localhost:8080](http://localhost:8080/).

### Overriding the default layout

Expand All @@ -87,10 +87,10 @@ docker run --rm -p "8080:8080" -v /path/to/custom_layout.json:/foxglove/default-

## Contributing

Foxglove Studio is written in TypeScript – contributions are welcome!
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.

## Credits

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.
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.
2 changes: 1 addition & 1 deletion benchmark/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Foxglove Studio Benchmarking
# Foxbox Benchmarking

Benchmarks are specific combinations of layout and synthetic data playback. When a benchmark is opened, playback automatically starts and summary results are printed to the developer console.

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "1.0.0",
"license": "MPL-2.0",
"private": true,
"productName": "Foxglove",
"description": "Core components of Foxglove Studio",
"productDescription": "Foxglove Studio",
"productName": "Foxbox",
"description": "Core components of Foxbox",
"productDescription": "Foxbox",
"packageManager": "[email protected]",
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/studio-base/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# @foxglove/studio-base &nbsp; [![npm version](https://img.shields.io/npm/v/@foxglove/studio-base.svg?style=flat)](https://www.npmjs.com/package/@foxglove/studio-base)

This package contains core components used in [Foxglove Studio](https://github.com/foxglove/studio).
This package contains core components used in [Foxbox](https://github.com/foxglove/studio).

## Quick start

When contributing to the [Foxglove Studio](https://github.com/foxglove/studio) codebase, you can import from `@foxglove/studio-base` at its top-level or from lower in its directory:
When contributing to the [Foxbox](https://github.com/foxglove/studio) codebase, you can import from `@foxglove/studio-base` at its top-level or from lower in its directory:

```
import { ExtensionInfo, ExtensionLoaderContext, ExtensionLoader } from "@foxglove/studio-base";
Expand Down
6 changes: 3 additions & 3 deletions packages/studio-base/src/PanelAPI/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PanelAPI

The `PanelAPI` namespace contains React [Hooks](https://reactjs.org/docs/hooks-intro.html) and components which allow panel authors to access Foxglove Studio data and metadata inside their panels. Using these APIs across all panels helps ensure that data appears consistent among panels, and makes it easier for panels to support advanced features (such as multiple simultaneous data sources).
The `PanelAPI` namespace contains React [Hooks](https://reactjs.org/docs/hooks-intro.html) and components which allow panel authors to access Foxbox data and metadata inside their panels. Using these APIs across all panels helps ensure that data appears consistent among panels, and makes it easier for panels to support advanced features (such as multiple simultaneous data sources).

To use PanelAPI, it's recommended that you import the whole namespace, so that all usage sites look consistent, like `PanelAPI.useSomething()`.

Expand All @@ -10,7 +10,7 @@ import * as PanelAPI from "@foxglove/studio-base/PanelAPI";

## [`PanelAPI.useDataSourceInfo()`](useDataSourceInfo.js)

"Data source info" encapsulates **rarely-changing** metadata about the sources from which Foxglove Studio is loading data. (A data source might be a local [bag file](http://wiki.ros.org/Bags/Format) dropped into the browser, or a bag stored on a remote server; see [players](../players) and [dataSources](../dataSources) for more details.)
"Data source info" encapsulates **rarely-changing** metadata about the sources from which Foxbox is loading data. (A data source might be a local [bag file](http://wiki.ros.org/Bags/Format) dropped into the browser, or a bag stored on a remote server; see [players](../players) and [dataSources](../dataSources) for more details.)

Using this hook inside a panel will cause the panel to re-render automatically when the metadata changes, but this won't happen very often or during playback.

Expand Down Expand Up @@ -63,7 +63,7 @@ These reducers should be wrapped in [`useCallback()`](https://reactjs.org/docs/h

- `restore: (?T) => T`:

- Called with `undefined` to initialize a new state when the panel first renders, and when the user seeks to a different playback time (at which point Foxglove Studio automatically clears out state across all panels).
- Called with `undefined` to initialize a new state when the panel first renders, and when the user seeks to a different playback time (at which point Foxbox automatically clears out state across all panels).
- Called with the previous state when the `restore` or `addMessage`/`addMessages` reducer functions change. This allows the panel an opportunity to reuse its previous state when a parameter changes, without totally discarding it (as in the case of a seek) and waiting for new messages to come in from the data source.

For example, a panel that filters some incoming messages can use `restore` to create a filtered value immediately when the filter changes. To implement this, the caller might switch from unfiltered reducers:
Expand Down
2 changes: 1 addition & 1 deletion packages/studio-base/src/i18n/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This directory contains localized strings for languages supported by Foxglove Studio.
This directory contains localized strings for languages supported by Foxbox.

To learn more about localization, see [CONTRIBUTING.md](../../../../CONTRIBUTING.md#localization).
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ import { RosDatatypes } from "@foxglove/studio-base/types/RosDatatypes";
import { basicDatatypes } from "@foxglove/studio-base/util/basicDatatypes";

import {
GetBackfillMessagesArgs,
IIterableSource,
IteratorResult,
Initalization,
IteratorResult,
MessageIteratorArgs,
GetBackfillMessagesArgs,
} from "../IIterableSource";

export class RosDb3IterableSource implements IIterableSource {
Expand Down Expand Up @@ -84,7 +84,7 @@ export class RosDb3IterableSource implements IIterableSource {
problems.push({
severity: "warn",
message: `Topic "${topicDef.name}" has unsupported datatype "${topicDef.type}"`,
tip: "ROS 2 .db3 files do not contain message definitions, so only well-known ROS types are supported in Foxbox Studio. As a workaround, you can convert the db3 file to mcap using the mcap CLI. For more information, see: https://docs.foxglove.dev/docs/connecting-to-data/frameworks/ros2",
tip: "ROS 2 .db3 files do not contain message definitions, so only well-known ROS types are supported in Foxbox. As a workaround, you can convert the db3 file to mcap using the mcap CLI. For more information, see: https://docs.foxglove.dev/docs/connecting-to-data/frameworks/ros2",
});
continue;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/studio-desktop/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# @foxglove/studio-desktop

This is an internal package used for bundling the Foxglove Studio desktop app. Its API is not considered public or stable.
This is an internal package used for bundling the Foxbox desktop app. Its API is not considered public or stable.
8 changes: 4 additions & 4 deletions packages/studio-desktop/src/electronBuilderConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ function makeElectronBuilderConfig(params) {
},
{
ext: "foxe",
name: "Foxbox Studio Extension",
name: "Foxbox Extension",
mimeType: "application/zip",
},
],
Expand Down Expand Up @@ -125,7 +125,7 @@ function makeElectronBuilderConfig(params) {
{
CFBundleTypeExtensions: ["foxe"],
CFBundleTypeIconFile: "FoxeIcon",
CFBundleTypeName: "Foxbox Studio Extension File",
CFBundleTypeName: "Foxbox Extension File",
CFBundleTypeRole: "Viewer",
LSHandlerRank: "Owner",
CFBundleTypeIconSystemGenerated: 1,
Expand All @@ -149,7 +149,7 @@ function makeElectronBuilderConfig(params) {
},
{
UTTypeConformsTo: ["public.data", "public.archive", "public.zip-archive"],
UTTypeDescription: "Foxbox Studio Extension File",
UTTypeDescription: "Foxbox Extension File",
UTTypeIcons: { UTTypeIconText: "foxe" },
UTTypeIdentifier: "dev.foxglove.extension",
UTTypeTagSpecification: { "public.filename-extension": "foxe" },
Expand All @@ -171,7 +171,7 @@ function makeElectronBuilderConfig(params) {
appx: {
applicationId: "FoxgloveStudio",
backgroundColor: "#f7def6",
displayName: "Foxbox Studio",
displayName: "Foxbox",
identityName: "Foxglove.Studio",
publisher:
"CN=Foxglove Technologies, O=Foxglove Technologies, L=San Francisco, S=California, C=US",
Expand Down
2 changes: 1 addition & 1 deletion packages/studio-web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# @foxglove/studio-web

This is an internal package used for bundling the Foxglove Studio web app. Its API is not considered public or stable.
This is an internal package used for bundling the Foxbox web app. Its API is not considered public or stable.
4 changes: 2 additions & 2 deletions packages/studio/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Foxglove Studio Extension API
# Foxbox Extension API

This package contains type definitions for writing [Foxglove Studio](https://foxglove.dev/) extensions.
This package contains type definitions for writing [Foxbox](https://foxglove.dev/) extensions.

See https://docs.foxglove.dev/docs/visualization/extensions/introduction

Expand Down
2 changes: 1 addition & 1 deletion packages/theme/src/i18n/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This directory contains localized strings for languages supported by Foxglove Studio.
This directory contains localized strings for languages supported by Foxbox.

To learn more about localization, see [CONTRIBUTING.md](../../../../CONTRIBUTING.md#localization).
2 changes: 1 addition & 1 deletion web/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This is an internal package used for bundling the Foxglove Studio web app. Its API is not considered public or stable.
This is an internal package used for bundling the Foxbox web app. Its API is not considered public or stable.
Loading