add readme
This commit is contained in:
parent
1dda00ab6f
commit
d737741029
0
readme-files/app.svg
Normal file
0
readme-files/app.svg
Normal file
BIN
readme-files/screenshot1.png
Normal file
BIN
readme-files/screenshot1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 182 KiB |
33
readme.md
Normal file
33
readme.md
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
# AnkiLan
|
||||||
|
App which provide translating and adding words to anki
|
||||||
|
|
||||||
|
- - -
|
||||||
|
![screenshot](./readme-files/screenshot1.png)
|
||||||
|
|
||||||
|
## Build and start
|
||||||
|
```shell
|
||||||
|
git clone https://github.com/Horhik/ankilan
|
||||||
|
yarn install
|
||||||
|
|
||||||
|
yarn start
|
||||||
|
# launch paralell
|
||||||
|
react-native run-android
|
||||||
|
|
||||||
|
```
|
||||||
|
if something not working read [react native docs](https://reactnative.dev/docs/getting-started)
|
||||||
|
|
||||||
|
## Debug
|
||||||
|
#####For linux:
|
||||||
|
Read [this](https://gist.github.com/Horhik/28c40259a79fabdd358822cede105c09#file-rn-redux-devtools-md)
|
||||||
|
Instead yarn start and react-native run-android, you may launch `./rn-start.sh` and `./tools-start.sh`
|
||||||
|
#####Other
|
||||||
|
It's up to you 😜
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
- [x] ~~Basic functional~~
|
||||||
|
- [ ] Add Urban dictionary support
|
||||||
|
- [ ] Support for other languages than Russian
|
||||||
|
- [ ] Add fields editor
|
||||||
|
- [ ] Add dark theme
|
||||||
|
- [ ] Create flexibility models
|
||||||
|
- [ ] Download sound of word to filesystem
|
Loading…
Reference in a new issue