https://github.com/jericks/geoscript-groovy-cookbook
A GeoScript Groovy Cookbook
https://github.com/jericks/geoscript-groovy-cookbook
asciidoc geospatial groovy
Last synced: about 2 months ago
JSON representation
A GeoScript Groovy Cookbook
- Host: GitHub
- URL: https://github.com/jericks/geoscript-groovy-cookbook
- Owner: jericks
- Created: 2016-12-06T03:37:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-05T18:19:10.000Z (over 2 years ago)
- Last Synced: 2024-01-29T11:20:42.313Z (about 2 years ago)
- Topics: asciidoc, geospatial, groovy
- Language: Groovy
- Homepage: https://jericks.github.io/geoscript-groovy-cookbook/
- Size: 807 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/jericks/geoscript-groovy-cookbook/actions)
GeoScript Groovy Cookbook
=========================
The GeoScript Groovy Cookbook contains short recipes showing how to use the GeoScript Groovy API.
[Web Site](https://jericks.github.io/geoscript-groovy-cookbook/)
[PDF](https://jericks.github.io/geoscript-groovy-cookbook/index.pdf)
Key Features
------------
1. Cookbook with Recipes
2. Code is unit tested
3. Images are generated by unit tests
4. Version specific
Adding Recipes
--------------
1. Add code to an existing recipes or create a new group of recipes in **src/main/groovy**.
The code for your recipe should be surrounded by special comments:
```
// tag::createPoint[]
Point point = new Point(-123,46)
// end::createPoint[]
```
And if the recipe is visual please create an image in the **src/docs/asciidoc/images** directory.
If the recipe outputs any text please save the file in the **src/docs/asciidoc/output** directory.
2. Second, add a test for your recipe so all code snippets are tested in **src/test/groovy**.
3. Finally, add your recipe to an assciidoc file in the **src/docs/asciidoc** directory.
Build
-----
```
mvn clean install
```
The generated web site can be found in the **target/generated-docs** directory.