menu-helper/README.md

25 lines
627 B
Markdown
Raw Normal View History

2024-09-05 18:59:41 +00:00
# Menu Helper
2024-09-24 16:24:42 +00:00
A program to manage a database of recipes and help you to pick out meals based
on filters of ingredients and tags.
2024-09-05 18:59:41 +00:00
## Usage
2024-09-24 16:24:42 +00:00
Ensure the `XDG_DATA_HOME` variable is set (e.g. to `$HOME/.local/share`).
2024-09-05 18:59:41 +00:00
## Building
2024-09-24 16:24:42 +00:00
To build the program you will require the following dependencies:
2024-10-09 17:50:53 +00:00
- A C++ compiler compatible with GNU99 C (preferably GCC).
- SQLite3 C/C++ library
2024-09-24 16:24:42 +00:00
- Make
Once installed, compile the project with the `make` command.
2024-09-05 18:59:41 +00:00
## License
2024-09-24 16:24:42 +00:00
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.