diff --git a/README.md b/README.md index 0ea9b35..d4c360a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ # Wince -A GTK 4 frontend for yelp +Adaptive GTK4 app for searching local businesses and restaurants. Powered by [Yelp](https://yelp.com). ## Build -You gotta have blueprint installed +### Depenencies + +* geoclue +* libshumate +* blueprint-compiler +* libadwaita +* gtk4 +* crystal + +If you're on arch you can run ``` -pacman -S blueprint-compiler crystal shards libadwaita +pacman -S blueprint-compiler crystal shards libadwaita libshumate georclue ``` -Then you gotta get an API key from YELP and put it in the file `api_key` at the root of the project +Then you gotta get an API key from Yelp and put it in the file `api_key` at the root of the project. Note: the `api_key1` file cannot contain a trailing newline. Then you can run the program with @@ -22,4 +31,6 @@ You can build for production with `make` and install with `make install` ## Credits -Marker icon from [Paomedia on iconfinder](https://www.iconfinder.com/icons/299087/marker_map_icon) \ No newline at end of file +Map marker icon from [Paomedia on iconfinder](https://www.iconfinder.com/icons/299087/marker_map_icon) + +The [Ultimate GTK4 crystal guide](https://ultimate-gtk4-crystal-guide.geopjr.dev/) without which I would not have been able to figure most of this out. \ No newline at end of file