Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjohannchang committed Mar 1, 2021
1 parent dcea1c1 commit cb0501e
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,46 @@
# Python GUI Application with Database Demo

## Development environment
## Installation

Install with [pip](https://pip.pypa.io/en/stable/) or download the pre-compiled executable file from [here](https://github.com/changyuheng/python-gui-application-with-database-demo/tags).

```
pip install git+https://github.com/changyuheng/python-gui-application-with-database-demo.git
```

## Usage

```
desktop-demo
```

## Development

### Environment

1. [Python 3.9.2+](https://www.python.org/downloads/release/python-392/)
2. [Poetry](https://python-poetry.org/)
3. [PyCharm](https://www.jetbrains.com/pycharm/)

### Setup

```
pip install poetry
poetry install
```

### Packaging

```
poetry run pyinstaller --add-data packages\desktop_demo\ui\main_window.ui;desktop_demo\ui --onefile .venv\Scripts\desktop-demo
```

### Key libraries

1. [dataset](https://dataset.readthedocs.io/en/latest/)
2. [Qt for Python](https://www.qt.io/qt-for-python)

## Design concepts
### Design concepts

1. [Object-oriented programming](https://en.wikipedia.org/wiki/Object-oriented_programming)
2. [Model–view–viewmodel (MVVM)](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93viewmodel)
Expand Down

0 comments on commit cb0501e

Please sign in to comment.