Changed README to highlight features
This commit is contained in:
parent
527d18f10a
commit
cb0d54c48d
1 changed files with 51 additions and 4 deletions
55
README.md
55
README.md
|
@ -1,11 +1,58 @@
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
![Logo](https://cdn.discordapp.com/icons/671688550311526413/67359a4a386c62bb66eaf4641ab8de5c.png?size=128)
|
<img src="img/logo.png" alt="drawing" width="300"/>
|
||||||
|
</div>
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
# Welsh Vocabulary Tutor
|
# Welsh Vocabulary Tutor
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
**Welsh Vocabulary Tutor** is a program that helps people store and learn Welsh vocabulary.
|
||||||
|
|
||||||
> This is the group repository for Group 20 doing the CS22120 Group Project 2020.
|
> This is the group repository for Group 20 doing the CS22120 Group Project 2020.
|
||||||
|
|
||||||
Welsh Vocabulary Tutor is a program that helps people store and learn Welsh vocabulary.
|
## Features:
|
||||||
|
### Dictionary
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<img src="img/dictionary-display.jpeg" alt="drawing" width="600"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
A page where you can view all the currently loaded words, from here you can add/remove to/from your practice list.
|
||||||
|
### Practice List
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<img src="img/practice-list-display.jpeg" alt="Practice List Page" width="600"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
This page displays all your practice words, once you're comfortable with a word you can remove it from your practice list through this page.
|
||||||
|
### Flashcards
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<img src="img/flashcard-display.jpeg" alt="Flashcard Page" width="600"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
This is a quick and easy way to go over your practice words, just like using flashcards in real life but without having to write them all out.
|
||||||
|
### Study
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<img src="img/study-display.jpeg" alt="Study Page" width="600"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Once you feel confident enough with some words you can test yourself from this page with a set of three test types.
|
||||||
|
### Adding new words
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<img src="img/add-word-display.jpeg" alt="Add Word Page" width="600"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Came across a word you would like to add to your vocabulary? No problem! From this page you can add new words to your existing word list, we'll even add it straight to your practice list so you can start trying to memorise it.
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
- Kain Bryan-Jones [kab74]
|
||||||
|
- Brad Corbett [brc9]
|
||||||
|
- Henry Dugmore [hjd3]
|
||||||
|
- Marcin Jakob [maj83]
|
||||||
|
- Tom Perry [top19]
|
||||||
|
- Oscar Pocock [osp1]
|
||||||
|
- Waylen Watts [ncw]
|
||||||
|
- Luke Wybar [law39]
|
Reference in a new issue