Skip to content

Commit

Permalink
Add readme to terrain example (#4535)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pessimistress committed Apr 29, 2020
1 parent b27aac3 commit 9ca3a46
Show file tree
Hide file tree
Showing 16 changed files with 43 additions and 15 deletions.
2 changes: 1 addition & 1 deletion examples/experimental/bezier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ npm start
```

### Data format
To use your own data, checkout the [documentation of BezierCurveLayer](../../docs/layers/bezier-curve-layer.md).
To use your own data, check out the [documentation of BezierCurveLayer](../../docs/layers/bezier-curve-layer.md).
2 changes: 1 addition & 1 deletion examples/website/3d-heatmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ npm start

### Data format

Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/3d-heatmap). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/3d-heatmap). To use your own data, check out
the [documentation of HexagonLayer](../../../docs/layers/hexagon-layer.md)
2 changes: 1 addition & 1 deletion examples/website/3d-tiles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ npm start

### Data format

Sample data is stored in Cesium ion server. To use your own data, checkout the [documentation of Tile3DLayer](../../../docs/layers/tile-3d-layer.md)
Sample data is stored in Cesium ion server. To use your own data, check out the [documentation of Tile3DLayer](../../../docs/layers/tile-3d-layer.md)
2 changes: 1 addition & 1 deletion examples/website/arc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ npm start

### Data format

Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/arc). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/arc). To use your own data, check out
the [documentation of ArcLayer](../../../docs/layers/arc-layer.md).
2 changes: 1 addition & 1 deletion examples/website/brushing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/arc). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/arc). To use your own data, check out
the [documentation of ArcLayer](../../../docs/layers/arc-layer.md).
2 changes: 1 addition & 1 deletion examples/website/data-filter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [kepler.gl Example Data](https://raw.githubusercontent.com/uber-web/kepler.gl-data/master/earthquakes/). To use your own data, checkout
Sample data is stored in [kepler.gl Example Data](https://raw.githubusercontent.com/uber-web/kepler.gl-data/master/earthquakes/). To use your own data, check out
the [documentation of DataFilterExtension](../../../docs/extensions/data-filter-extension.md).
2 changes: 1 addition & 1 deletion examples/website/geojson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/geojson). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/geojson). To use your own data, check out
the [documentation of GeoJsonLayer](../../../docs/layers/geojson-layer.md).
2 changes: 1 addition & 1 deletion examples/website/highway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/geojson). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/geojson). To use your own data, check out
the [documentation of GeoJsonLayer](../../../docs/layers/geojson-layer.md).
2 changes: 1 addition & 1 deletion examples/website/icon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ npm start


### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/icon). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/icon). To use your own data, check out
the [documentation of IconLayer](../../../docs/layers/icon-layer.md).
2 changes: 1 addition & 1 deletion examples/website/line/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/line). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/line). To use your own data, check out
the [documentation of LineLayer](../../../docs/layers/line-layer.md).
2 changes: 1 addition & 1 deletion examples/website/mesh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ npm start

This example generates an arbitrary set of data points.

To use your own data, checkout
To use your own data, check out
the [documentation of SimpleMeshLayer](../../../docs/layers/simple-mesh-layer.md).
2 changes: 1 addition & 1 deletion examples/website/plot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ npm start
```

### Data format
Sample data is stored in the `data` folder. To use your own data, checkout
Sample data is stored in the `data` folder. To use your own data, check out
the [documentation of PlotLayer](./plot-layer/README.md).
2 changes: 1 addition & 1 deletion examples/website/scatterplot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/scatterplot). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/scatterplot). To use your own data, check out
the [documentation of ScatterplotLayer](../../../docs/layers/scatterplot-layer.md).
2 changes: 1 addition & 1 deletion examples/website/screen-grid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/screen-grid). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/screen-grid). To use your own data, check out
the [documentation of ScreenGridLayer](../../../docs/layers/screen-grid-layer.md).
28 changes: 28 additions & 0 deletions examples/website/terrain/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
This is a minimal standalone version of the TerrainLayer example
on [deck.gl](http://deck.gl) website.

### Usage

Copy the content of this folder to your project.

To load the terrain tiles, you need a [Mapbox access token](https://docs.mapbox.com/help/how-mapbox-works/access-tokens/). You can either set an environment variable:

```bash
export MapboxAccessToken=<mapbox_access_token>
```

Or set `MAPBOX_TOKEN` directly in `app.js`.


```bash
# install dependencies
npm install
# or
yarn
# bundle and serve the app with webpack
npm start
```

### Data format
Mapbox's [terrain API](https://docs.mapbox.com/help/troubleshooting/access-elevation-data/#mapbox-terrain-rgb) encodes elevation data in raster tiles. To use other data sources, check out
the [documentation of TerrainLayer](../../../docs/layers/terrain-layer.md).
2 changes: 1 addition & 1 deletion examples/website/trips/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ npm start
```

### Data format
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/trips). To use your own data, checkout
Sample data is stored in [deck.gl Example Data](https://github.com/visgl/deck.gl-data/tree/master/examples/trips). To use your own data, check out
the [documentation of TripsLayer](../../../docs/layers/trips-layer.md).

0 comments on commit 9ca3a46

Please sign in to comment.