nortega/menu-helper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
A small program to help pick meals from a database of recipes.
33 Commits 1 Branch 1 Tag 217 KiB
C++ 90%
Roff 5.9%
Makefile 4.1%
d8a140e913
Go to file
Nicolás Ortega Froysa d8a140e913 Add Contributing section to README.
2024-10-21 14:17:34 +02:00
src Normalize use of const in db method parameters. 2024-10-21 14:05:26 +02:00
.gitignore Ignore files related to NeoVim CoC plugin usage. 2024-09-17 17:49:56 +02:00
LICENSE Initial commit. 2024-09-05 21:01:24 +02:00
Makefile Finish porting to C++. 2024-10-10 07:27:22 +02:00
README.md Add Contributing section to README. 2024-10-21 14:17:34 +02:00
TODO.md Add To-Do list. 2024-10-21 14:11:06 +02:00

README.md

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.

Contributing

If you find any issues, feel free to report them on GitHub or send me an E-Mail (see my website/profile for the address). I will add these issues to my personal Gitea page and (unless specified otherwise) mention you as the person who found the issue.

For patches/pull requests, if you open a PR on GitHub I will likely not merge directly but instead apply the patches locally (via Git patches, conserving authorship), push them to my Gitea repository, which will finally be mirrored to GitHub. However, you can save me a bit of work by just sending me the Git patches directly (via E-Mail).

If you're looking for a way to contribute, consider having a look at my To-Do list for the project.

License

This program is licensed under the terms & conditions of the GNU General Public License version 3 or greater. See the LICENSE file for more information.