Add README and LICENSE
This commit is contained in:
parent
d7ab357ee0
commit
c682915e9b
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 Etenie
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -0,0 +1,63 @@
|
||||||
|
# Nutri
|
||||||
|
|
||||||
|
Nutri is a C++ project that retrieves and processes nutritional information from various sources.
|
||||||
|
|
||||||
|
## Currently supported sources
|
||||||
|
|
||||||
|
- [x] WolframAlpha
|
||||||
|
- [ ] OpenFoodFacts
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- [x] Fetch and display nutrition data
|
||||||
|
- [ ] Export data to a CSV file
|
||||||
|
- [ ] Cache previous queries
|
||||||
|
- [ ] alternative [QT](qt.io) based GUI
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- [`glaze`](https://github.com/stephenberry/glaze)
|
||||||
|
- [`cpr`](https://github.com/libcpr/cpr)
|
||||||
|
- [`ctre`](https://github.com/hanickadot/compile-time-regular-expressions)
|
||||||
|
|
||||||
|
These libraries will be fetched automatically via CMake if they are not already installed on your system.
|
||||||
|
|
||||||
|
### Clone the repository
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone --depth=1 https://git.etenie.net/etenie/nutri.git
|
||||||
|
cd nutri
|
||||||
|
```
|
||||||
|
|
||||||
|
### Build with CMake
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake -S . -B build
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you will find the `nutri` executable in the `build` dir.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help: Print help
|
||||||
|
-f, --food: Specify the food item
|
||||||
|
-a, --amount: Specify the amount (in grams)
|
||||||
|
```
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./nutri -f "ground beef" -a 100
|
||||||
|
Cals: 236 kcal
|
||||||
|
Protein: 26 g
|
||||||
|
Carbs: 0 g
|
||||||
|
Fats: 14 g
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
Loading…
Reference in New Issue