Skip to content

Commit 50232fe

Browse files
authored
Update README.md
v0.2.0
1 parent 84cb069 commit 50232fe

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,30 @@
1-
# todo-app
1+
![app_icon](https://github.com/user-attachments/assets/2ddff14c-a387-4d8d-859a-1993192c8194)
22

3-
A minimalistic FOSS to-do app for Windows, Mac and Linux using Python and JSON.
3+
[![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=fff)](#) [![Windows](https://custom-icon-badges.demolab.com/badge/Windows-0078D6?logo=windows11&logoColor=white)](#) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-darkred.svg)](https://www.gnu.org/licenses/gpl-3.0)
44

5-
![TodoApp-preview](https://github.com/user-attachments/assets/c758accf-241b-4498-a8b4-01bf909dbadf)
5+
# Todo App for Windows
66

7-
### Download Portable for Windows 10/11: 🔗 [TodoApp.exe](https://github.com/jltk/todo-app/releases/download/0.1.0/TodoApp.exe)
7+
A simple and private to-do deskop app using python tkinter and local storage for Windows.
8+
9+
Free and open-source alternative to the Microsoft To Do app using no third-party dependencies.
10+
11+
![screenshot](https://github.com/user-attachments/assets/f1058d19-6700-4d37-aa7a-35d4cfa3c6ef)
812

913
## Features
1014

1115
- Simple and intuitive interface
12-
- Dark mode and light mode
13-
- Local storage with JSON file, no database needed
14-
- Lightweight free open-source software
15-
- No third-party requirements
16+
- Dark mode
17+
- Own your data using local storage with JSON
18+
- Privacy-focused free open-source software
19+
- No third-party dependencies
1620

1721
## Installation
1822

19-
Check the [latest releases page](https://github.com/jltk/todo-app/releases).
23+
### Download Portable .EXE for Windows 10/11: [🔗 TodoApp-0.2.0.zip](https://github.com/jltk/todo-app/releases/download/0.2.0/To-Do.zip) [6,18 MB]
24+
25+
or [visit the release page](https://github.com/jltk/todo-app/releases).
26+
27+
### Build from source
2028

2129
To run this application, you need Python 3.6 or higher.
2230

@@ -36,25 +44,28 @@ cd todo-app
3644

3745
```bash
3846
pip install -r requirements.txt
39-
4047
```
4148

4249
4. Run the application:
4350

4451
```bash
45-
python -m todo_app.app
46-
52+
python todo_app.app
4753
```
4854

49-
To bake exe for Windows use auto-py-to-exe.
50-
5155
## Shortcuts
5256

53-
- Ctrl+D: Dark mode
54-
- Ctrl+U: Mark task as urgent
55-
- Ctrl+M: Mark task as done
56-
- Ctrl+Del: Delete task
57+
| KEYS | DESCRIPTION |
58+
| ---- | ----------- |
59+
| **Ctrl+D** | Mark tasks as done |
60+
| **Ctrl+U** | Mark tasks as urgent |
61+
| **Ctrl+Del** | Delete tasks |
62+
| **Ctrl+R** | Toggle dark mode |
63+
| **Ctrl+H** | About window |
64+
65+
## Contribute
66+
67+
Star and fork the repo and contribute improvements and fixes to the project.
5768

5869
## License
5970

60-
This project is licensed under the GNU GPL License - see the LICENSE file for details.
71+
This project is licensed under the GPL license, [read the LICENSE file for details](https://github.com/jltk/todo-app/blob/main/LICENSE).

0 commit comments

Comments
 (0)