diff --git a/README.md b/README.md new file mode 100644 index 0000000..b09fcf5 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +

Packaged Food Explorer

+ +

+ GUI Application that explore and analyze packaged food dataset +
+ Data Source + +

+ + +## Table of contents + +- [Table of contents](#table-of-contents) +- [Quick start](#quick-start) +- [What's included](#whats-included) + + +## Quick start +- Clone github repository +``` +git clone https://github.com/Sosokker/Food-Nutrient-Viewer-Tkinter +``` +- run setup.py or pip +```py +# pip +pip install -r requirements.txt +``` +```py +# or setup.py +python setup.py install + +``` + +- To start GUI window run app.py +```py +python app.py +``` + +## What's included + +```text +Main/ +│── Essential/ +│ ├── descriptive.py +│ ├── FoodSearch.py +│ ├── networkgraphprob.ipynb +│ ├── plotter.py +│ ├── prepare_db.py +│ ├── data/ +│ │ ├── food_data.db +│ │ │── japan_data.csv +│ │ │── thai_data.csv +│ │ │── us_data_1.csv +│ │ │── us_data_2.csv +│ │ │── us_data_3.csv +│ │ └── us_data_4.csv +│── resources/ +│ ├──loading.gif +│ └──notfound.png +│── app.py +│── main.ipynb +│── setup.py +│── requirements.txt +└── README.md +```