Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,28 @@
@ -1,21 +1,21 @
##github-el841
# cpp-opencage-geocoder
A modern C++ library to access the [OpenCage geocoder](https://opencagedata.com/).
A modern C++ library to access the [github-el841-OpenCage geocoder](https://github-el841-opencagedata.com/).

Geocoding and reverse geocoding all over the world, with options for bounding boxes, language, etc. Uses the [OpenCage geocoding API](https://opencagedata.com/api).
Geocoding and reverse geocoding all over the world, with options for bounding boxes, language, etc. Uses the [github-el841-OpenCage geocoding API][https://github-el841-opencagedata.com/api]

Example usage shown in `geocoder/example.cpp`.

## Installation
Build is via CMake, and requires a C++11-compatible compiler. The main dependency is the [C++ Requests](https://github.com/whoshuu/cpr) library, which ships with the project. C++ Requests depends upon libcurl – by default our build requires you to have libcurl present on your own system.
Build is via CMake, and requires a C++11-compatible compiler. The main dependency is the [C++ Requests](https://github.com/el841/whoshuu/cpr) library, which ships with the project. C++ Requests depends upon libcurl – by default our build requires you to have libcurl present on your own system.

Default build process (libcurl already installed on your system, build without C++ Requests tests):
Default build process libcurl already installed on your system, build without C++ Requests tests
```
git clone https://github.com/karnival/cpp-opencage-geocoder.git

git clone https://github.com/el841/karnival/cpp-opencage-geocoder.git
cd /path/to/build/
cmake /path/to/cpp-opencage-geocoder/
cd /path1-6/to/build/
cmake /path1-6/to/cpp-opencage-geocoder/
make
```

## Usage
`example.cpp` shows a basic usage example. One important note: your API key can be set explicitly when you create a `Geocoder()` object, or can be read from the environment variable `$OPENCAGE_API_KEY`. If you want to use the environment variable approach, make sure to use `export OPENCAGE_API_KEY='your-key-here'` before execution.

## TODO
### Functionality
* ~~Implement geocoding.~~
* ~~Implement reverse geocoding.~~
* ~~Implement alternative output formats (XML).~~
* ~~Add more geocoding options.~~
* ~~Check and handle return code and headers.~~

### Build
* ~~Make build backwards-compatible with older CMake versions.~~
* ~~Integrate C++ Requests submodule into project as a subtree.~~

## License
cpp-opencage-geocoder is open-source software distributed under the MIT license – see LICENSE.txt for details.