diff --git a/README.md b/README.md index b09fcf5..9a4ff28 100644 --- a/README.md +++ b/README.md @@ -11,26 +11,30 @@ ## Table of contents - [Table of contents](#table-of-contents) +- [Feature](#feature) - [Quick start](#quick-start) - [What's included](#whats-included) +- [How to use](#how-to-use) +- [Used library and modules](#used-library-and-modules) +- [GUI](#gui) +- [UML Class Diagram and Design Pattern](#uml-class-diagram-and-design-pattern) +- [Example of sequence diagram](#example-of-sequence-diagram) +- [NOTE](#note) +## Feature + +- Filter and plot data of each product ## Quick start - Clone github repository ``` git clone https://github.com/Sosokker/Food-Nutrient-Viewer-Tkinter ``` -- run setup.py or pip +- pip install ```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 @@ -56,10 +60,41 @@ Main/ │ │ └── us_data_4.csv │── resources/ │ ├──loading.gif -│ └──notfound.png +│ ├──notfound.png +│ └──gui_main.png │── app.py │── main.ipynb -│── setup.py │── requirements.txt └── README.md ``` +## How to use + +## Used library and modules + +- tkinter +- sqlite3 +- plotly +- matplotlib +- pandas +- numpy +- pillow + +## GUI + +![GUI](/resources/gui_main.png) + +## UML Class Diagram and Design Pattern + +![UML](/resources/UML-Class-Diagram-Facade.png) + +- Use Facade Design Pattern + +## Example of sequence diagram + +![Seq](/resources/sequnce-diagram-plotter.png) + +## NOTE + +- Process data with file [main.ipynb](/main.ipynb) need .csv file from Data Source + +- If error about "food_data.db" occur download food_data.db and put in folder [data](/Essential/data/) \ No newline at end of file diff --git a/resources/UML-Class-Diagram-Facade.png b/resources/UML-Class-Diagram-Facade.png new file mode 100644 index 0000000..926ab5a Binary files /dev/null and b/resources/UML-Class-Diagram-Facade.png differ diff --git a/resources/gui_main.png b/resources/gui_main.png new file mode 100644 index 0000000..b3bd371 Binary files /dev/null and b/resources/gui_main.png differ diff --git a/resources/sequnce-diagram-plotter.png b/resources/sequnce-diagram-plotter.png new file mode 100644 index 0000000..7664d18 Binary files /dev/null and b/resources/sequnce-diagram-plotter.png differ