Skip to content

Commit a1efd4e

Browse files
committed
Update readme.
1 parent 1998270 commit a1efd4e

File tree

8 files changed

+28
-52
lines changed

8 files changed

+28
-52
lines changed

README.md

+28-52
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,45 @@
1-
![build](https://img.shields.io/github/actions/workflow/status/shanukun/Ziho/ziho.yml)
2-
![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/w/shanukun/Ziho/main)
3-
4-
# Ziho
5-
6-
Ziho is an online programme for flashcards. It helps the user memorise information by utilising cognitive science strategies like spaced repetition and active recall testing.
7-
8-
9-
## Built With
1+
<p align="center">
2+
<img title="Ziho Logo" src="https://shanukun.github.io/static/images/ziho/ziho-logo.png" align="center">
3+
</p>
104

11-
- [Flask](https://flask.palletsprojects.com/en/3.0.x/)
12-
- [SQLite](https://sqlite.org/)
13-
- [Docker](https://www.docker.com/)
5+
<p align="center">
6+
<b>Create, Study and Share</b> decks of flashcards.
7+
</p>
148

15-
## Screenshots
9+
<p align="center">
1610

17-
<p float="left">
18-
<img src="./screenshots/home.png" width="400">
19-
<img src="./screenshots/create-deck.png" width="400">
20-
<img src="./screenshots/view-deck.png" width="400">
21-
<img src="./screenshots/study.png" width="400">
22-
<img src="./screenshots/updatecard.png" width="400">
23-
<img src="./screenshots/profile.png" width="400">
24-
<img src="./screenshots/explore.png" width="400">
11+
<a href="https://img.shields.io/github/actions/workflow/status/shanukun/Ziho/ziho.yml">
12+
<img title="Build Status" src="https://img.shields.io/github/actions/workflow/status/shanukun/Ziho/ziho.yml" />
13+
</a>
14+
<a href="https://readthedocs.org/projects/activitywatch/badge/?version=latest">
15+
<img title="Github commit activity" src="https://img.shields.io/github/commit-activity/w/shanukun/Ziho/main" />
16+
</a>
2517
</p>
2618

2719

28-
## Getting Started
20+
## About
2921

30-
### Install & Run
22+
Ziho is a prototype for a better online interface for Anki than [Anki Web](https://ankiweb.net/decks).
23+
Ziho allows you to create, study and easily share and clone decks, as well as edit them online.
3124

32-
- Setup
33-
```
34-
./tools/setup
35-
```
25+
The backend is built with **Flask**, and the [fsrs](https://github.com/open-spaced-repetition) algorithm is used for spaced repetition.
3626

37-
- Run
27+
<span><img src="https://shanukun.github.io/static/images/ziho/home.png" width="30%"></span>
28+
<span><img src="https://shanukun.github.io/static/images/ziho/study-deck.png" width="25%"></span>
3829

39-
```
40-
./tools/run-ziho
41-
```
30+
You can find more screenshots [here](https://shanukun.github.io/ziho-ss/).
4231

43-
- For dev enviroment
4432

45-
```
46-
./tools/run-ziho-dev
47-
```
48-
49-
- For docker container
50-
51-
```
52-
docker compose up
53-
```
54-
55-
## Contribution
33+
## Getting Started
5634

57-
**Be consistent with existing code**
35+
### Quick Start with Docker
5836

59-
### Use the linters
37+
> [!IMPORTANT]
38+
> Please ensure you have Docker and Docker Compose installed on your system.
6039
40+
1. **Clone the Repository.**
41+
2. **Start the Docker Container**
42+
```bash
43+
docker compose up -d
6144
```
62-
./tools/lint_and_format
63-
```
64-
65-
### Use the tests
6645

67-
```
68-
pytest tests/
69-
```

screenshots/create-deck.png

-83.4 KB
Binary file not shown.

screenshots/explore.png

-80.9 KB
Binary file not shown.

screenshots/home.png

-111 KB
Binary file not shown.

screenshots/profile.png

-62.6 KB
Binary file not shown.

screenshots/study.png

-81.6 KB
Binary file not shown.

screenshots/updatecard.png

-106 KB
Binary file not shown.

screenshots/view-deck.png

-113 KB
Binary file not shown.

0 commit comments

Comments
 (0)