diff --git a/readme-files/app.svg b/readme-files/app.svg new file mode 100644 index 0000000..e69de29 diff --git a/readme-files/screenshot1.png b/readme-files/screenshot1.png new file mode 100644 index 0000000..9da9a89 Binary files /dev/null and b/readme-files/screenshot1.png differ diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..79dc8af --- /dev/null +++ b/readme.md @@ -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 \ No newline at end of file