First commit of README.md

README.md

@@ -0,0 +1,65 @@
+  <h3 align="center">Packaged Food Explorer</h3>
+
+  <p align="center">
+    GUI Application that explore and analyze packaged food dataset
+    <br>
+    <a href="[https://reponame/issues/new?template=bug.md](https://world.openfoodfacts.org/data)">Data Source</a>
+    
+</p>
+
+
+## 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
+```