Update docs

- Add SCRIPTS.md
- Remove memes from BUILDING.md

docs/BUILDING.md

@@ -9,10 +9,9 @@ A `PKGBUILD` file will be created for Arch Linux systems once Darkwrite reaches
 Clone the repository and enter it. I strongly recommend installing Git if you haven't already.
 
 # Building on Windows
-I'm continuing development on Windows for now. As far as I'm concerned, Linux in a virtual machine runs Darkwrite faster than Edge WebView2. I had to cripple down blur effects quite a bit so Edge could handle it. I also had to recently switch to dnd-kit as drag-drop library, because HTML5 drag-drop and native file drop functionality doesn't work with Tauri on Windows for whatever reason.  
-
 Darkwrite stores application data in `%USERPROFILE%/AppData/Roaming/io.github.astudentinearth.darkwrite` directory.
 ### C++ Build Tools Setup
+You can skip directly to the Rust installation section if you don't have it. Rustup can automatically install C++ Build Tools for you.
 Download the [Visual Studio Community installer.](https://visualstudio.microsoft.com/)
 Once the installer launches, choose "Desktop development with C++" and "Windows 10 SDK" workloads to be installed.
 
@@ -26,25 +25,22 @@ Go to https://www.rust-lang.org/tools/install and get rustup. The installer will
 Download (preferably the latest version of) Node.js from the official site. It should come with npm by default.
 
 ## Build
-Building is very straight forward. 
+Type the following commands to your terminal.
 ```
-npm install
+npm ci
 npm run tauri build
 ```
-
-...should do it for you. The resulting package will be placed in `src-tauri\target\release`
+The resulting package will be placed in `src-tauri\target\release`
 
 # Building on Linux
 Darkwrite stores application data at `$XDG_CONFIG_HOME/io.github.astudentinearth.darkwrite` or `$HOME/.config/io.github.astudentinearth.darkwrite`.
-**Do NOT run Darkwrite with root privileges under any circumstances. Darkwrite doesn't access anywhere outside its configuration folder by default, but a bug in the backend might nuke your system, you never know.**  
-A pic of your `neofetch` is highly appreciated when creating an issue.
+**Do NOT run Darkwrite with root privileges under any circumstances. Bugs might be destructive, same goes for any other app.**  
+A screenshot of your `neofetch` is highly appreciated when creating an issue.
 ## System dependencies
 Install the packages below that correspond to your distribution. (Source: Tauri Documentation)
-If you are feeling great today, also add Vim to make your day even better.
 **Make sure you update your system packages beforehand to avoid partial upgrades.**  
 ### Debian / Ubuntu
 I recommend building on Ubuntu 22.04 (any flavor of Ubuntu is OK), which is also used for building with GitHub Actions. If you are on Linux Mint/LMDE, PeppermintOS, Kali Linux, Raspberry Pi OS or elementaryOS these should also work. *I probably will not package Darkwrite as a snap.*  
-If you are on SteamOS 2 for whatever reason, do something good for yourself by switching to something else.
 ```
 sudo apt update
 sudo apt install libwebkit2gtk-4.0-dev \
@@ -57,7 +53,7 @@ sudo apt install libwebkit2gtk-4.0-dev \
     librsvg2-dev
 ```
 ### Arch Linux
-This should apply to pretty much every Arch-based system(including Garuda Linux and EndeavourOS), unless they replace these with custom repositories. I used Arch Linux extensively while creating Darkwrite, and it should run just fine. **Manjaro might have dependency issues when building with the future PKGBUILD since they hold packages back.** If you are using SteamOS I recommend just getting the AppImage, use your CPU power for your library instead :)
+This should apply to pretty much every Arch-based system(including Garuda Linux and EndeavourOS), unless they replace these with custom repositories. I used Arch Linux extensively while creating Darkwrite, and it should run just fine. **Manjaro might have dependency issues when building with the future PKGBUILD since they hold packages back.**
 ```
 sudo pacman -Syu
 sudo pacman -S --needed \
@@ -85,7 +81,6 @@ sudo dnf install webkit2gtk4.0-devel \
 sudo dnf group install "C Development Tools and Libraries"
 ```
 ### openSUSE
-Both Leap and Tumbleweed editions should work fine.
 ```
 sudo zypper up
 sudo zypper in webkit2gtk3-soup2-devel \
@@ -97,22 +92,12 @@ sudo zypper in webkit2gtk3-soup2-devel \
 sudo zypper in -t pattern devel_basis
 ```
 ### Nix
-Go to https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-linux and follow instructions for NixOS. NixOS requires some configuration I can't explain here. I also have no idea about how Nix packaging works ¯\_(ツ)_/¯
+Go to https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-linux and follow instructions for NixOS.
 
 ### Gentoo
-If you are on Gentoo, don't bloat up your system by building webkit2gtk. It will also be a pain for you when updating @world set. I recommend simply using the AppImage like any normal person. But if there is not an AppImage available for the specific commit you need/you will make changes to the code, or simply want to contribute to the project, here you go. I might write an ebuild after setting up a Gentoo virtual machine.
-
-These steps should work on both OpenRC and systemd, but I can't give a guarantee for musl. If you are using systemd on Gentoo, I hope you are having a good day. 
-
-I had to look up dependency for their equivalents on the Gentoo package index, I hope this saves you some time. Make sure you have configured `ACCEPT_LICENSE` variable in your portage configuration properly. The command below should work on stable (not bleeding edge) systems, but if you are on bleeding edge (i.e. your `ACCEPT_KEYWORDS` is set to `~amd64`), this should also work(will add extra overhead to your updates however).  
 You need to enable the `npm` local use flag for `net-libs/nodejs` to have npm installed.
 ```emerge -av net-libs/webkit-gtk net-misc/curl net-misc/wget dev-libs/openssl x11-misc/appmenu-gtk-module x11-libs/gtk+ dev-libs/libappindicator gnome-base/librsvg sys-devel/binutils sys-devel/gcc sys-devel/libtool net-libs/nodejs```
-This command has the potential of taking hours because of the WebKit engine, so be patient. Once you are done, proceed with the steps below to install Rust and continue with the build. Go ahead and post your beautiful dwm setup at r/unixporn in the end.  
-
-Note: If you are using LibreSSL for whatever reason, good chance it won't work.
-
-### LFS
-Assuming you have proceeded to BLFS and got a desktop running, you can install the same dependencies listed in the Gentoo section.
+This command has the potential of taking hours because of the WebKit engine, so be patient. Once you are done, proceed with the steps below to install Rust and continue with the build.
 
 ### Void Linux
 Install `libwebkitgtk60 libwebkitgtk60-devel curl wget openssl openssl-devel appmenu-gtk-module appmenu-gtk-module-devel gtk+3 gtk+3-devel libappindicator libappindicator-devel gcc librsvg librsvg-devel binutils` packages using xbps. I don't know if these packages are overkill/insufficient. I have never used Void before.
@@ -151,4 +136,4 @@ npm run tauri dev
 ...should drop a `.dmg` somewhere in `src-tauri/target/release`. **Note that the .dmg is not signed, so Apple might complain about unidentified developer. You can create an exception in System Preferences.**
 
 # Updating manual builds
-Darkwrite dependencies may get updated as a part of project progression. Therefore I recommend running `npm install` before every compilation to ensure correct node dependencies are available. I also recommend updating your Rust toolchain and Node.JS / npm from time to time. (If you are on Linux and installed Rust, node or npm using your package manager, they should get updated automatically with your system.)
+Darkwrite dependencies may get updated as a part of project progression. Therefore I recommend running `npm ci` before every compilation to ensure correct node dependencies are available. I also recommend updating your Rust toolchain and Node.JS / npm from time to time. (If you are on Linux and installed Rust, node or npm using your package manager, they should get updated automatically with your system.)

docs/SCRIPTS.md

@@ -0,0 +1,15 @@
+# NPM scripts for development
+### `start`
+Starts vite with source code watching
+### `build`
+Builds the frontend code.
+### `vite-watch`
+Starts vite with source code watching. Uses cross-env to ensure it runs on all platforms.
+### `app_build`
+Enumerates license files for dependencies and combines them, which gets included in the source code.
+### `lint:sort-locale`
+Sorts the keys in locale files.
+### `tauri dev`
+Runs the application in developer mode. Code changes are reflected immediately with hot reload.
+### `tauri build`
+Builds the code for the current platform.

package.json

@@ -28,8 +28,6 @@
   "scripts": {
     "start": "conc 'npm:vite-watch'",
     "build": "cross-env CI=false tsc && npm run app_build && vite build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject",
     "tauri": "tauri",
     "vite-watch": "cross-env BROWSER=none vite",
     "app_build": "generate-license-file --input package.json --output src/3rd-party-licenses.txt --overwrite",