From 17c23a3cfdff0e1b5f8b6826ffdc8f43822dcc55 Mon Sep 17 00:00:00 2001
From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Date: Tue, 29 Nov 2022 18:32:35 +0100
Subject: docs: General cleanup (#89)

* docs: Remove section mentioning old compile method

This method no longer works since the UI rewrite and switch to Vue

* docs: Add note about auto-recompile

* docs: Make setup instructions a bit clearer

* docs: Format word bold

"backend" was formatted but "frontend" wasn't cause I overlooked it.
---
 docs/DEVELOPMENT.md | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

(limited to 'docs')

diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
index c6e8301e..8e9ace32 100644
--- a/docs/DEVELOPMENT.md
+++ b/docs/DEVELOPMENT.md
@@ -1,6 +1,6 @@
 # Development
 
-FlightCore uses [Tauri](https://tauri.app/) as its UI framework. This means it is split into a **backend** written in [Rust](https://www.rust-lang.org/) and a frontend written in [Vue](https://vuejs.org/) and [TypeScript](https://www.typescriptlang.org/).
+FlightCore uses [Tauri](https://tauri.app/) as its UI framework. This means it is split into a **backend** written in [Rust](https://www.rust-lang.org/) and a **frontend** written in [Vue](https://vuejs.org/) and [TypeScript](https://www.typescriptlang.org/).
 
 ## Design goals
 
@@ -12,10 +12,10 @@ As for splitting logic between _frontend_ and _backend_, state and UI related lo
 
 ## Setup
 
-Make sure you have the necessary dependencies installed: https://tauri.app/v1/guides/getting-started/prerequisites
+Make sure you have the necessary dependencies for Tauri installed as described in this link: https://tauri.app/v1/guides/getting-started/prerequisites
 
 
-Install `npm` dependencies with 
+Then, install `npm` dependencies with
 
 ```sh
 npm install
@@ -33,6 +33,8 @@ Then for developing
 npx tauri dev
 ```
 
+Automatic recompiling on save is enabled for both the Rust and the Typescript/Vue code.
+
 ## Tauri
 
 An introduction to Tauri can be seen in this short YouTube video: https://youtu.be/-X8evddpu7M
@@ -152,10 +154,6 @@ else {
 
 ```
 
-## Building
-
-Release builds are generally done via CI. To build locally, make sure typescript is compiled (`./node_modules/.bin/rollup --config`), then run `npm run tauri build`.
-
 ## Other
 
 This repo uses [EditorConfig](https://editorconfig.org/) to define some basic formatting rules. Find a plugin for your IDE [here](https://editorconfig.org/#download).
-- 
cgit v1.2.3