alicia/wince
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Better explanations in the readme

Browse Source
This commit is contained in:
Alicia Moore
2022-12-24 21:11:37 -08:00
parent 349a6cf756
commit c5091351e2
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,16 +1,25 @@
# Wince # Wince
A GTK 4 frontend for yelp Adaptive GTK4 app for searching local businesses and restaurants. Powered by [Yelp](https://yelp.com).
## Build ## 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 Then you can run the program with
@@ -22,4 +31,6 @@ You can build for production with `make` and install with `make install`
## Credits ## Credits
Marker icon from [Paomedia on iconfinder](https://www.iconfinder.com/icons/299087/marker_map_icon) 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.