crystal-linux-mirror
/
jade
mirror of https://git.getcryst.al/crystal/software/jade.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update template.md, README.md

Browse Source
main
Hericium VEVO 2 years ago
parent b7b1d38cc8
commit 1abeb4bc95
2 changed files with 120 additions and 58 deletions
Show Stats Download Patch File Download Diff File

113
README.md
Unescape Escape View File

@ -1,123 +1,119 @@
<p align="center">
<a href="https://git.getcryst.al/crystal/software/jade/"> # Jade
<img src="https://getcryst.al/site/assets/other/logo.png" alt="Logo" width="150" height="150">
</a> Jade is an installer backend for crystal linux.
</p>
<h2 align="center">Jade</h2>
<p align="center">
<a href="https://git.getcryst.al/crystal/info/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPL--3.0-blue.svg" alt="License">
<a href="https://git.getcryst.al/crystal/software/jade"><img alt="Gitlab issues" src="https://img.shields.io/gitlab/issues/open/crystal/software/jade?gitlab_url=https%3A%2F%2Fgit.getcryst.al%2F"></a>
<a href="https://git.getcryst.al/crystal/software/jade"><img alt="Gitlab merge requests" src="https://img.shields.io/gitlab/merge-requests/open/crystal/software/jade?gitlab_url=https%3A%2F%2Fgit.getcryst.al%2F"></a><br>
<a href="https://discord.gg/hYJgu8K5aA"><img alt="Discord" src="https://img.shields.io/discord/825473796227858482?color=blue&label=Discord&logo=Discord&logoColor=white"> </a>
<a href="https://git.getcryst.al/axtlos"><img src="https://img.shields.io/badge/Maintainer-@axtloss-brightgreen" alt=The maintainer of this repository" href="https://git.getcryst.al/axtlos"></a>
<a href="https://fosstodon.org/@crystal_linux"><img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/108618426259408142?domain=https%3A%2F%2Ffosstodon.org">
<a href="https://twitter.com/crystal_linux"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/crystal_linux"></a>
</p>
<p align="center">Jade is an installer backend for crystal linux.</p>
## Backend usage ## Backend usage
### autopartition the drive ### Autopartition the drive
```sh ```sh
# autopartition /dev/sda with efi enabled # autopartition /dev/sda with efi enabled
jade partition auto /dev/sda --efi $ crystal-jade partition auto /dev/sda --efi
# autopartition /dev/nvmen0 with efi disabled # autopartition /dev/nvmen0 with efi disabled
jade partition auto /dev/nvmen0 $ crystal-jade partition auto /dev/nvmen0
``` ```
### install base packages ### Install base packages
```sh ```sh
jade install-base $ crystal-jade install-base
``` ```
### install bootloader ### Install bootloader
```sh ```sh
# install as efi with esp being /boot/efi # install as efi with esp being /boot/efi
jade bootloader grub-efi /boot/efi $ crystal-jade bootloader grub-efi /boot/efi
# install as legacy on /dev/sda # install as legacy on /dev/sda
jade bootloader grub-legacy /dev/sda $ crystal-jade bootloader grub-legacy /dev/sda
``` ```
### generate fstab ### Generate fstab
```sh ```sh
jade genfstab $ crystal-jade genfstab
``` ```
### configuring locale settings ### Configuring locale settings
```sh ```sh
# set the keyboard layout to colemak, the timezone to Europe/Berlin and set en_US.UTF-8 as the locale # 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 $ crystal-jade locale colemak Europe/Berlin en_US.UTF-8 UTF-8
``` ```
### configure network settings ### Configure network settings
```sh ```sh
# set the hostname to getcryst.al with ipv6 disabled # set the hostname to getcryst.al with ipv6 disabled
jade networking getcryst.al $ crystal-jade networking getcryst.al
# set the hostname to getcryst.al with ipv6 enabled # set the hostname to getcryst.al with ipv6 enabled
jade networking getcryst.al --ipv6 $ crystal-jade networking getcryst.al --ipv6
``` ```
### setup zramd ### Setup zramd
```sh ```sh
# install and enable zramd # install and enable zramd
jade zramd $ crystal-jade zramd
``` ```
### configure users ### Configure users
```sh ```sh
# make a new user called nonRootHaver, without sudo, easytohack as the password and bash as the default shell # make a new user called nonRootHaver, without sudo, easytohack as the password and bash as the default shell
jade users new-user nonRootHaver easytohack bash $ crystal-jade users new-user nonRootHaver easytohack bash
# make a user called rootHaver, with sudo, omgsosuperhardtohack as the password and fish as the default shell # make a user called rootHaver, with sudo, omgsosuperhardtohack as the password and fish as the default shell
jade users new-user rootHaver omgsuperhardtohack fish --hasroot $ crystal-jade users new-user rootHaver omgsuperhardtohack fish --hasroot
``` ```
### set root password ### Set root password
```sh ```sh
# set the root password to 'muchSecurity,veryHardToHack' # set the root password to 'muchSecurity,veryHardToHack'
jade users root-password muchSecurity,veryHardToHack $ crystal-jade users root-password muchSecurity,veryHardToHack
``` ```
### install a desktop environment ### Install a desktop environment
```sh ```sh
# install onyx # install onyx
jade desktops onyx $ crystal-jade desktops onyx
# install gnome # install gnome
jade desktops gnome $ crystal-jade desktops gnome
``` ```
### setup timeshift ### Setup timeshift
```sh ```sh
jade setup-timeshift $ crystal-jade setup-timeshift
``` ```
### setup flatpak ### Setup flatpak
```sh ```sh
jade flatpak $ crystal-jade flatpak
``` ```
### debug logging ### Debug logging
debug messages: debug messages:
```sh ```sh
jade -v $ crystal-jade -v
``` ```
traces: traces:
```sh ```sh
jade -vv $ crystal-jade -vv
``` ```
## How to build:
Tested on latest Cargo (1.60.0-nightly)
## Non-secret Secret
echo "$ crystal-jade_UWU=true" >> ~/.zshrc <br>
echo "$ crystal-jade_UWU=true" >> ~/.bashrc <br>
set -Ux $ crystal-jade_UWU true <br>
<br> <br>
if you want to have your log and crash output be “cute”
## 🙌 Contributing
If you'd like to contribute to **Jade**, please follow the [Crystal Linux contributing guidelines](https://git.getcryst.al/crystal/info/-/blob/main/CONTRIBUTING.md)!
This project uses `rustup`, to set up `cargo` for **Jade** development, please follow the guidelines below:
#### Debug/development builds #### Debug/development builds
@ -127,9 +123,10 @@ Tested on latest Cargo (1.60.0-nightly)
- `cargo build --release` - `cargo build --release`
## Non-secret Secret
echo "JADE_UWU=true" >> ~/.zshrc <br>
echo "JADE_UWU=true" >> ~/.bashrc <br> ## 📜 License
set -Ux JADE_UWU true <br>
<br> [GPLv3-only](https://choosealicense.com/licenses/gpl-3.0/)
if you want to have your log and crash output be “cute”
![](https://git.getcryst.al/crystal/misc/branding/-/raw/main/banners/README-banner.png)

65
template.md
Unescape Escape View File

@ -0,0 +1,65 @@
# {{name}}
{{desc}}
## 💡 Features
- {{feature_list}}
## 📚 Documentation
Documentation for this project is available [here](https://docs.getcryst.al)!
**Support** is also available in our [Discord](https://getcryst.al/discord) and the [Matrix](https://matrix.to/#/#space:getcryst.al). If you face any issues with the software, feel free to open an issue on this repository.
## 👥 Contributors
A list of all **{{name}}** contributors is available in [CONTRIBUTORS.md](CONTRIBUTORS.md)
For a list of **{{name}}** maintainers specifically, see [.gitlab/CODEOWNERS](.gitlab/CODEOWNERS)
## 💾 Installation
### 💽 From Binary
**Install {{name}} using `{{toolkit}}`**
```bash
$ {{toolkit}} install {{name}}
$ {{name}}
```
### 🏗 From Source
**Install {{name}} from source using `cargo`**
```bash
$ git clone https://git.getcryst.al/{{path}} && cd {{name}}
$ cargo install --path .
```
## 📸 Screenshots
![App Screenshot](https://via.placeholder.com/468x300?text=App+Screenshot+Here)
## 🙌 Contributing
If you'd like to contribute to **{{name}}**, please follow the [Crystal Linux contributing guidelines](https://git.getcryst.al/crystal/info/-/blob/main/CONTRIBUTING.md)!
This project uses `{{toolkit}}`, to set up `{{toolkit}}` for **{{name}}** development, please follow the guidelines below:
{{instructions}}
We are also constantly looking for translators for our i18n-enabled projects! If you speak more than one language, consider helping out on our [Weblate](https://i18n.getcryst.al)!
![https://i18n.getcryst.al/engage/crystal-linux/](https://i18n.getcryst.al/widgets/crystal-linux/-/287x66-black.png)
## 📜 License
[GPLv3-only](https://choosealicense.com/licenses/gpl-3.0/)
![](https://git.getcryst.al/crystal/misc/branding/-/raw/main/banners/README-banner.png)
Write Preview
Loading…
Cancel
Save