menu-helper/README.md

25 lines
625 B
Markdown

# Menu Helper
A program to manage a database of recipes and help you to pick out meals based
on filters of ingredients and tags.
## Usage
Ensure the `XDG_DATA_HOME` variable is set (e.g. to `$HOME/.local/share`).
## Building
To build the program you will require the following dependencies:
- A C++ compiler compatible with C++20 (preferably GCC).
- SQLite3 C/C++ library
- Make
Once installed, compile the project with the `make` command.
## License
This program is licensed under the terms & conditions of the GNU General Public
License version 3 or greater. See the [LICENSE](/LICENSE) file for more
information.