Skip to content

Commit 36a557c

Browse files
authored
fix: Updates all README files with descriptions. (#919)
1 parent b3d91cc commit 36a557c

File tree

83 files changed

+556
-342
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+556
-342
lines changed

samples/3d-accessibility-features/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-accessibility-features
4+
5+
The 3d-accessibility-features sample demonstrates how to use accessibility features in a 3D map, such as keyboard and screen reader support.
6+
7+
Follow these instructions to set up and run 3d-accessibility-features sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-accessibility-features/`
2326

2427
### Build all of the examples.
2528

samples/3d-camera-boundary/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-camera-boundary
4+
5+
The 3d-camera-boundary sample demonstrates how to set a boundary for the camera in a 3D map to restrict the user's view.
6+
7+
Follow these instructions to set up and run 3d-camera-boundary sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-camera-boundary/`
2326

2427
### Build all of the examples.
2528

samples/3d-camera-to-around/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-camera-to-around
4+
5+
The 3d-camera-to-around sample demonstrates how to control the camera in a 3D map to look around a point.
6+
7+
Follow these instructions to set up and run 3d-camera-to-around sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-camera-to-around/`
2326

2427
### Build all of the examples.
2528

samples/3d-label-toggle/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-label-toggle
4+
5+
The 3d-label-toggle sample demonstrates how to toggle the visibility of labels in a 3D map.
6+
7+
Follow these instructions to set up and run 3d-label-toggle sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-label-toggle/`
2326

2427
### Build all of the examples.
2528

samples/3d-localization/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-localization
4+
5+
The 3d-localization sample demonstrates how to localize a 3D map by changing the language and region.
6+
7+
Follow these instructions to set up and run 3d-localization sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-localization/`
2326

2427
### Build all of the examples.
2528

samples/3d-map-styling/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-map-styling
4+
5+
The 3d-map-styling sample demonstrates how to apply custom styles to a 3D map.
6+
7+
Follow these instructions to set up and run 3d-map-styling sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-map-styling/`
2326

2427
### Build all of the examples.
2528

samples/3d-marker-click-event/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-marker-click-event
4+
5+
The 3d-marker-click-event sample demonstrates how to handle click events on 3D markers.
6+
7+
Follow these instructions to set up and run 3d-marker-click-event sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-marker-click-event/`
2326

2427
### Build all of the examples.
2528

samples/3d-marker-collision-behavior/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-marker-collision-behavior
4+
5+
The 3d-marker-collision-behavior sample demonstrates how to control the collision behavior of 3D markers.
6+
7+
Follow these instructions to set up and run 3d-marker-collision-behavior sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-marker-collision-behavior/`
2326

2427
### Build all of the examples.
2528

samples/3d-marker-customization/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-marker-customization
4+
5+
The 3d-marker-customization sample demonstrates how to customize the appearance of 3D markers.
6+
7+
Follow these instructions to set up and run 3d-marker-customization sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-marker-customization/`
2326

2427
### Build all of the examples.
2528

@@ -29,5 +32,4 @@ From `samples/`:
2932
## Feedback
3033

3134
For feedback related to this sample, please open a new issue on
32-
[GitHub](https://github.com/googlemaps-samples/js-api-samples/issues).
33-
35+
[GitHub](https://github.com/googlemaps-samples/js-api-samples/issues).

samples/3d-marker-graphics/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Google Maps JavaScript Sample
22

3-
This sample is generated from @googlemaps/js-samples located at
4-
https://github.com/googlemaps-samples/js-api-samples.
3+
## 3d-marker-graphics
4+
5+
The 3d-marker-graphics sample demonstrates how to use graphics to create custom 3D markers.
6+
7+
Follow these instructions to set up and run 3d-marker-graphics sample on your local computer.
58

69
## Setup
710

@@ -19,7 +22,7 @@ First `cd` to the folder for the sample to run, then:
1922

2023
From `samples/`:
2124

22-
`$npm run build --workspace=sample-name/`
25+
`$npm run build --workspace=3d-marker-graphics/`
2326

2427
### Build all of the examples.
2528

@@ -29,5 +32,4 @@ From `samples/`:
2932
## Feedback
3033

3134
For feedback related to this sample, please open a new issue on
32-
[GitHub](https://github.com/googlemaps-samples/js-api-samples/issues).
33-
35+
[GitHub](https://github.com/googlemaps-samples/js-api-samples/issues).

0 commit comments

Comments
 (0)