From 705d9ce243bf8486c6c8c420e31130aef3a3a661 Mon Sep 17 00:00:00 2001 From: HGEpro <tstudio2007@gmail.com> Date: Thu, 31 Mar 2022 14:27:58 +0200 Subject: [PATCH] fix typo in readme titles --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0b2e146..cdfa89f 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,16 @@ LibreHomework is an app made by students and for students. Features - Custom network where you can meet other students through their profiles (50% done) - Available in multiple languages -##Project info +## Project info The project is divided in 3 parts: - [The app/client](https://github.com/HGEpro/LibreHomework/tree/master/app) is written with Rust (backend) and [Tauri](https://github.com/tauri-apps/tauri) + [Svelte](https://github.com/sveltejs/svelte) (frontend). Why did we choose Tauri? Because it's an amazing framework that allows you to write Electron-like desktop apps with [much less resource consumption](https://github.com/tauri-apps/tauri#comparison-between-tauri-and-electron) while still using flexible web technologies. Why Svelte? We all know javascript has lots of frameworks, but Svelte is intuitive and easy to use while at the same time fast as there's no virtual DOM. - [The daemon](https://github.com/HGEpro/LibreHomework/tree/master/daemon) is written with pure Rust to achieve a low resource consumption. It can be configured by editing the daemonconfig.json in the `.config/LibreHomework` file, but now it needs to be done manually. - [The server](https://github.com/HGEpro/LibreHomework/tree/master/server) is written in Python with [Sanic](https://github.com/sanic-org/sanic) and postgresql. Why did we choose Python for the server? At first, it was intended to be written with Rust and Rocket.rs, but we finally decided to use python due to security concerns in the SQL library (injections). -##Installation +## Installation You can found the compiled releases in the [Releases section](https://github.com/HGEpro/LibreHomework/releases). -##Setup +## Setup To run or compile the app from source, you can use the following commands: ``` @@ -34,12 +34,12 @@ And for building the app you can use: $ npm run tauri build ``` -##Contributing +## Contributing If you want to contribute to the project, you can fork the project and make your changes or just open a pull request. -##Credits +## Credits Thanks to [Wolfram](https://github.com/fabiopolancoe) for the UI code and [YeahNotSewerSide](https://github.com/DoctorEenot) for the technical support. -##Additional info +## Additional info This project has been created for the [YH4F](https://fsf.org/yh4f). -- GitLab