diff --git a/README.md b/README.md index 28eecc5..0a39413 100755 --- a/README.md +++ b/README.md @@ -1,85 +1,86 @@ - - Logo - -

-

Jade

-

- Discord -

- -

Jade is the backend and TUI installer for crystal linux.

- -## Use the TUI (not implemented yet) -just run
-`jade` - -## Backend usage - -### autopartition the drive -```sh -# autopartition /dev/sda with efi enabled -jade partition auto /dev/sda --efi - -# autopartition /dev/nvmen0 with efi disabled -jade partition auto /dev/nvmen0 -``` - -### configuring locale settings -```sh -# set the keyboard layout to colemak, the timezone to Europe/Berlin and set en_US.UTF-8 as the locale -jade locale colemak Europe/Berlin "en_US.UTF-8 UTF-8" -``` - -### configue network settings -```sh -# set the hostname to getcryst.al with ipv6 disabled -jade networking getcryst.al - -# set the hostname to getcryst.al with ipv6 enabled -jade networking getcryst.al --ipv6 -``` - -### configure users -```sh -# make a new user called nonRootHaver, without sudo and easytohack as the password -jade users newUser nonRootaver false easytohack - -# make a user called rootHaver, with sudo and omgsosuperhardtohack as the password -jade users rootHaver true omgsosuperhardtohack -``` - -### set root password -```sh -# set the root password to 'muchSecurity,veryHardToHack' -jade users rootPass muchSecurity,veryHardToHack -``` - -### install a desktop environment -```sh -# install onyx -jade desktops onyx - -# install gnome -jade desktops gnome -``` - -## How to build: - -Tested on latest Cargo (1.60.0-nightly) - -
- -#### Debug/development builds - -- `cargo build` - -#### Optimised/release builds - -- `cargo build --release` - - -echo "JADE_UWU=true" >> ~/.zshrc -echo "JADE_UWU=true" >> ~/.bashrc -set -Ux JADE_UWU true - +

+ + Logo + +

+

Jade

+

+ Discord +

+ +

Jade is the backend and TUI installer for crystal linux.

+ +## Use the TUI (not implemented yet) +just run
+`jade` + +## Backend usage + +### autopartition the drive +```sh +# autopartition /dev/sda with efi enabled +jade partition auto /dev/sda --efi + +# autopartition /dev/nvmen0 with efi disabled +jade partition auto /dev/nvmen0 +``` + +### configuring locale settings +```sh +# set the keyboard layout to colemak, the timezone to Europe/Berlin and set en_US.UTF-8 as the locale +jade locale colemak Europe/Berlin "en_US.UTF-8 UTF-8" +``` + +### configue network settings +```sh +# set the hostname to getcryst.al with ipv6 disabled +jade networking getcryst.al + +# set the hostname to getcryst.al with ipv6 enabled +jade networking getcryst.al --ipv6 +``` + +### configure users +```sh +# make a new user called nonRootHaver, without sudo and easytohack as the password +jade users newUser nonRootaver false easytohack + +# make a user called rootHaver, with sudo and omgsosuperhardtohack as the password +jade users rootHaver true omgsosuperhardtohack +``` + +### set root password +```sh +# set the root password to 'muchSecurity,veryHardToHack' +jade users rootPass muchSecurity,veryHardToHack +``` + +### install a desktop environment +```sh +# install onyx +jade desktops onyx + +# install gnome +jade desktops gnome +``` + +## How to build: + +Tested on latest Cargo (1.60.0-nightly) + +
+ +#### Debug/development builds + +- `cargo build` + +#### Optimised/release builds + +- `cargo build --release` + + +echo "JADE_UWU=true" >> ~/.zshrc +echo "JADE_UWU=true" >> ~/.bashrc +set -Ux JADE_UWU true + if you want to have your log and crash output be "cute" \ No newline at end of file