Skip to content

Commit a15c847

Browse files
committed
chore(README): update docs
1 parent 58e8df3 commit a15c847

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,32 @@
22

33
Avoc is a GEOINT tool which combines multiple map providers and view modes in one single interface, and equipped with a series of companion tools for scraping geotagged/georeferenced contents.
44

5-
# Under the hood
5+
## Setup
6+
7+
### From Github
8+
1. Clone the repo
9+
2. Copy the file `configuration.js.sample` into `configuration.js`
10+
3. Open `configuration.js` and add a valid Google Maps' API key to apiKeys.google
11+
12+
### Manually
13+
1. Download the latest release [available here](https://github.com/haruspeks/avoc/releases)
14+
2. Open `configuration.js` and add a valid Google Maps' API key to apiKeys.google
15+
16+
### How to obtain a Google Maps API key
17+
A good how-to guide is [available here](https://dev.to/simplecodeagency/how-to-setup-a-new-google-maps-api-key-4kp1).
18+
19+
## Under the hood
620

721
- [Pico.css](https://picocss.com/)
822
- [Alpine.js](https://alpinejs.dev/)
23+
- [RequireJS](https://requirejs.org/)
24+
- Weather data powered by [OpenMeteo](https://open-meteo.com/)
25+
- Altitude data powered by [OpenMeteo](https://open-meteo.com/) and [Open-Elevation](https://www.open-elevation.com/)
926

10-
# Browser compatibility
27+
## Browser compatibility
1128

1229
Edge 16+, Firefox 52+, Safari 10+, Chrome 57+, Opera 44+.
1330

14-
# Credits
31+
## Credits
1532

1633
`kiwi-bird` favicon by [Free Icons](https://free-icons.github.io/free-icons/).

0 commit comments

Comments
 (0)