Skip to content

Commit

Permalink
Cleanup images, spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
ggetz committed Dec 14, 2022
1 parent 48efed4 commit 7047efe
Show file tree
Hide file tree
Showing 7 changed files with 155 additions and 14 deletions.
61 changes: 61 additions & 0 deletions Documentation/Images/Cesium_dark_color.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions Documentation/Images/Cesium_light_color.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Documentation/OfflineGuide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const viewer = new Cesium.Viewer("cesiumContainer", {

## 3D Tiles, glTF, and other static files

Most other files loaded in CesiumJS, such as 3D Tiles or glTF, are static assets that do not require any server-side operations to load. However, since browsers commonly treat requests to load resources using the `file://` schema as cross-origin requests, it's reccomended that you set up a local server.
Most other files loaded in CesiumJS, such as 3D Tiles or glTF, are static assets that do not require any server-side operations to load. However, since browsers commonly treat requests to load resources using the `file://` schema as cross-origin requests, it's recommended that you set up a local server.

1. Download and install [Node.js](https://nodejs.org/en/download/)

Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# CesiumJS

![Cesium](https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg)

[![Build Status](https://travis-ci.com/CesiumGS/cesium.svg?branch=main)](https://travis-ci.com/CesiumGS/cesium)
[![npm](https://img.shields.io/npm/v/cesium)](https://www.npmjs.com/package/cesium)
[![Docs](https://img.shields.io/badge/docs-online-orange.svg)](https://cesium.com/learn/)

<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./Documentation/images/Cesium_light_color.svg">
<source media="(prefers-color-scheme: light)" srcset="./Documentation/images/Cesium_dark_color.svg">
<img alt="Cesium" src="https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg" width="300">
</picture>
<!-- markdownlint-restore -->

CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin. It uses WebGL for hardware-accelerated graphics, and is cross-platform, cross-browser, and tuned for dynamic-data visualization.

Built on open formats, CesiumJS is designed for robust interoperability and scaling for massive datasets.
Expand Down Expand Up @@ -34,7 +41,7 @@ import "cesium/Build/Cesium/Widgets/widgets.css";
const viewer = new CesiumWidgets.Viewer("cesiumContainer");
```

Or, import individual modules to benefit from tree shaking optmtimizations through most build tools:
Or, import individual modules to benefit from tree shaking optimizations through most build tools:

```js
import { Viewer } from "cesium";
Expand All @@ -45,7 +52,7 @@ const viewer = new Viewer("cesiumContainer");

#### Packages

In addition to the `cesium` package, CesiumJS is also distrubuted as scoped npm packages for more specific dependency management:
In addition to the `cesium` package, CesiumJS is also distributed as scoped npm packages for more specific dependency management:

- [`@cesium/engine`](./packages/engine/README.md) - CesiumJS's core, rendering, and data APIs
- [`@cesium/widgets`](./packages/widgets/README.md) - A widgets library for use with CesiumJS
Expand Down Expand Up @@ -75,7 +82,7 @@ Our mission is to create the leading 3D globe and map for static and time-dynami

The Cesium platform follows an [open-core business model](https://cesium.com/why-cesium/open-ecosystem/cesium-business-model/) with open source runtime engines such as CesiumJS and optional commercial subscription to Cesium ion.

CesiumJS can stream [3D content such as terrain, imagery, and 3D Tiles from the commercial Cesium ion platform](https://cesium.com/platform/cesium-ion/content/) alongside open standards from other offline or online servives. We provide Cesium ion as the quickest option for all users to get up and running, but you are free to use any combination of content sources with CesiumJS that you please.
CesiumJS can stream [3D content such as terrain, imagery, and 3D Tiles from the commercial Cesium ion platform](https://cesium.com/platform/cesium-ion/content/) alongside open standards from other offline or online services. We provide Cesium ion as the quickest option for all users to get up and running, but you are free to use any combination of content sources with CesiumJS that you please.

[Using Cesium ion](https://cesium.com/ion/signup/) helps support CesiumJS development. :heart:

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
"build-docs-watch": "gulp buildDocsWatch",
"eslint": "eslint \"./**/*.js\" \"./**/*.cjs\" \"./**/*.html\" --cache --quiet",
"make-zip": "gulp makeZip",
"markdownlint": "markdownlint \"*.md\" \"Documentation/**/*.md\" --ignore CHANGES.md --ignore \"./**/LICENSE.md\"",
"markdownlint": "markdownlint \"*.md\" \"Documentation/**/*.md\" \"packages/**/*.md\" --ignore CHANGES.md --ignore \"./**/LICENSE.md\"",
"release": "gulp release",
"website-release": "gulp websiteRelease",
"test": "gulp test",
Expand All @@ -158,7 +158,7 @@
"prettier --write"
],
"*.md": [
"markdownlint --ignore CHANGES.md --ignore LICENSE.md --ignore \"./**/LICENSE.md\"",
"markdownlint --ignore CHANGES.md --ignore \"./**/LICENSE.md\"",
"prettier --write"
]
},
Expand Down
13 changes: 10 additions & 3 deletions packages/engine/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# @cesium/engine

![Cesium](https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg)

[![Build Status](https://travis-ci.com/CesiumGS/cesium.svg?branch=main)](https://travis-ci.com/CesiumGS/cesium)
[![npm](https://img.shields.io/npm/v/@cesium/engine)](https://www.npmjs.com/package/@cesium/engine)
[![Docs](https://img.shields.io/badge/docs-online-orange.svg)](https://cesium.com/learn/)

<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../../Documentation/images/Cesium_light_color.svg">
<source media="(prefers-color-scheme: light)" srcset="../../Documentation/images/Cesium_dark_color.svg">
<img alt="Cesium" src="https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg" width="300">
</picture>
<!-- markdownlint-restore -->

[CesiumJS](../../README.md) is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin. It uses WebGL for hardware-accelerated graphics, and is cross-platform, cross-browser, and tuned for dynamic-data visualization.

`@cesium/engine` includes cesiumJS's core, rendering, and data APIs. Here you'll find terrain and imagery engines, support for 3D Tiles and 3D models, geometries, and vector data.
Expand Down Expand Up @@ -38,7 +45,7 @@ import "@cesium/engine/Source/Widget/CesiumWidget.css";
const cesiumWidget = new Cesium.CesiumWidget("cesiumContainer");
```

Or, import individual modules to benefit from tree shaking optmtimizations through most build tools:
Or, import individual modules to benefit from tree shaking optimizations through most build tools:

```js
import { CesiumWidget } from "@cesium/engine";
Expand Down
13 changes: 10 additions & 3 deletions packages/widgets/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# @cesium/widgets

![Cesium](https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg)

[![Build Status](https://travis-ci.com/CesiumGS/cesium.svg?branch=main)](https://travis-ci.com/CesiumGS/cesium)
[![npm](https://img.shields.io/npm/v/@cesium/widgets)](https://www.npmjs.com/package/@cesium/widgets)
[![Docs](https://img.shields.io/badge/docs-online-orange.svg)](https://cesium.com/learn/)

<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../../Documentation/images/Cesium_light_color.svg">
<source media="(prefers-color-scheme: light)" srcset="../../Documentation/images/Cesium_dark_color.svg">
<img alt="Cesium" src="https://github.com/CesiumGS/cesium/wiki/logos/Cesium_Logo_Color.jpg" width="300">
</picture>
<!-- markdownlint-restore -->

[CesiumJS](../../README.md) is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin. It uses WebGL for hardware-accelerated graphics, and is cross-platform, cross-browser, and tuned for dynamic-data visualization.

`@cesium/widgets` is a widgets library for use with CesiumJS— including the `CesiumViewer` widget plus widgets for common tasks such as animation, base layer selection and geocoding.
Expand Down Expand Up @@ -38,7 +45,7 @@ import "@cesium/widgets/Source/widgets.css";
const viewer = new CesiumWidgets.Viewer("cesiumContainer");
```

Or, import individual modules to benefit from tree shaking optmtimizations through most build tools:
Or, import individual modules to benefit from tree shaking optimizations through most build tools:

```js
import { Viewer } from "@cesium/widgets";
Expand Down

0 comments on commit 7047efe

Please sign in to comment.