Add information to README.md

This commit is contained in:
Nicolás A. Ortega Froysa 2024-09-24 18:24:42 +02:00
parent 393dbb88d4
commit ca544e74fa

View File

@ -1,7 +1,24 @@
# Menu Helper # 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 ## Usage
Ensure the `XDG_DATA_HOME` variable is set (e.g. to `$HOME/.local/share`).
## Building ## Building
To build the program you will require the following dependencies:
- A C compiler compatible with GNU99 C (preferably GCC).
- SQLite3 C library
- Make
Once installed, compile the project with the `make` command.
## License ## 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.