Readme fixes

This commit is contained in:
Abraham
2023-04-28 19:41:44 +05:00
parent d9c0ac77c9
commit 9e6aa9458a

View File

@@ -7,7 +7,7 @@ The main project challenges we try to achieve is:
- Open source *(full transparency)*
- No data collection *(we respect your privacy)*
Our backend stack is 🦀 **[Rust](https://www.rust-lang.org/)** with ❤️ **[Tauri](https://tauri.app/)**.
Our backend stack is 🦀 **[Rust](https://www.rust-lang.org/)** with ❤️ **[Tauri](https://tauri.app/)**.<br>
For the frontend we use ⚡️ **[Vite](https://vitejs.dev/)** + 🛠️ **[Svelte](https://svelte.dev/)**.
*Other libraries, tools and packages can be found in source code.*
@@ -15,9 +15,6 @@ For the frontend we use ⚡️ **[Vite](https://vitejs.dev/)** + 🛠️ **[Svel
[Silero](https://github.com/snakers4/silero-models) & [Vosk](https://pypi.org/project/vosk/).
Later on [Picovoice Porcupine Wake Word Detection](https://picovoice.ai/platform/porcupine/) & [ChatGPT](https://chat.openai.com/) was added.
Hi! I'm your first Markdown file in **StackEdit**. If you want to learn about StackEdit, you can read me. If you want to play with Markdown, you can edit me. Once you have finished with me, you can create new files by opening the **file explorer** on the left corner of the navigation bar.
## Neural Networks
This are the neural networks we are currently using:
@@ -35,21 +32,25 @@ This are the neural networks we are currently using:
## Supported Languages
Currently, only Russian language is supported.
Currently, only Russian language is supported.<br>
But soon, Ukranian and English will be added.
## How to build?
Nothing special was used to build this project.
You need only Rust and NodeJS installed on your system.
Other than that, all you need is to install all the dependencies and then compile the code with `cargo tauri build` command.
Nothing special was used to build this project.<br>
You need only Rust and NodeJS installed on your system.<br>
Other than that, all you need is to install all the dependencies and then compile the code with `cargo tauri build` command.<br>
Or run dev with `cargo tauri dev`.
## Author
## Python version?
Old version of Jarvis was build with Python.<br>
The last Python version commit can be found [here](https://github.com/Priler/jarvis/tree/943efbfbdb8aeb5889fa5e2dc7348ca4ea0b81df).
Abraham Tugalov
## License
[Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/)
[Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/)<br>
See LICENSE.txt file for more details.