From 3c5a97c759e0fbe82edf07fbd56eacd81c02ffe7 Mon Sep 17 00:00:00 2001 From: nyx Date: Fri, 1 Nov 2024 17:09:07 -0400 Subject: [PATCH] run cargo xtask docgen --- docs/userguide.md | 51 ++++++++++++----------------------------------- 1 file changed, 13 insertions(+), 38 deletions(-) diff --git a/docs/userguide.md b/docs/userguide.md index 8ad704e6..e406993c 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -17,7 +17,6 @@ ### Developer Tools - **Github Desktop**: GitHub Desktop is a user-friendly application that simplifies the process of managing Git repositories and interacting with GitHub, providing a graphical interface for tasks like committing, branching, and syncing changes. -- **JetBrains Toolbox**: JetBrains Toolbox is a collection of tools and an app that help developers work with JetBrains products. - **Meld**: Meld is a visual diff and merge tool that helps compare files, directories, and version-controlled projects. - **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim. It is not a rewrite but a continuation and extension of Vim. @@ -45,15 +44,10 @@ https://github.com/ChrisTitusTech/neovim - **Thorium**: Thorium is a Chromium-based browser focused on privacy and performance. - **Vivaldi**: Vivaldi is a freeware, cross-platform web browser developed by Vivaldi Technologies. - **waterfox**: Waterfox is the privacy-focused web browser engineered to give you speed, control, and peace of mind on the internet. -- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. -This command installs and condifures alacritty terminal emulator. +- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. This command installs and configures alacritty terminal emulator. - **Android Debloater**: Universal Android Debloater (UAD) is a tool designed to help users remove bloatware and unnecessary pre-installed applications from Android devices, enhancing performance and user experience. -- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. -It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. -This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. -https://github.com/ChrisTitusTech/mybash -- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. -Bottles also provides tools to categorize, organize and optimize your applications. +- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash +- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. Bottles also provides tools to categorize, organize and optimize your applications. - **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers. - **DWM-Titus**: DWM is a dynamic window manager for X. It manages windows in tiled, monocle and floating layouts. @@ -61,41 +55,26 @@ All of the layouts can be applied dynamically, optimising the environment for th This command installs and configures DWM and a desktop manager. The list of patches applied can be found in CTT's DWM repository https://github.com/ChrisTitusTech/dwm-titus -- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. -It is written mainly in C, with performance and customizability in mind. -This command installs fastfetch and configures from CTT's mybash repository. -https://github.com/ChrisTitusTech/mybash -- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. -This command installs Flatpak and adds the Flathub repository +- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. It is written mainly in C, with performance and customizability in mind. This command installs fastfetch and configures from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash +- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. This command installs Flatpak and adds the Flathub repository - **Grub Theme**: Installs ChrisTitusTech's Top 5 Bootloader Themes script to allow for easy customization of GRUB. -- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. -kitty is written in a mix of C and Python programming languages. - This command installs and configures kitty. +- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty. - **Linutil Installer**: Installs a distro-specific Linutil package locally. - **Linutil Updater**: Updates your local Linutil crate installation. -- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. -This command installs and configures rofi with configuration from CTT's DWM repo. -https://github.com/ChrisTitusTech/dwm-titus +- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. This command installs and configures rofi with configuration from CTT's DWM repo. https://github.com/ChrisTitusTech/dwm-titus - **Waydroid**: Waydroid is an emulator that allows you to run Android apps and games on Linux. -- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. -This command installs ZSH prompt and provides basic configuration. +- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. This command installs ZSH prompt and provides basic configuration. ## Gaming ### Diablo II Resurrected -- **Loot Filter**: This is a loot filter for Diablo II Resurrected. -It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. -Works on battle.net and single player. -No frills, no config, just highlights high runes and other valuable items. -For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter +- **Loot Filter**: This is a loot filter for Diablo II Resurrected. It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. Works on battle.net and single player. No frills, no config, just highlights high runes and other valuable items. For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter ## Security -- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. -This command installs UFW and configures UFW based on CTT's recommended rules. -For more information visit: https://christitus.com/linux-security-mistakes +- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. This command installs UFW and configures UFW based on CTT's recommended rules. For more information visit: https://christitus.com/linux-security-mistakes ## System Setup @@ -103,19 +82,15 @@ For more information visit: https://christitus.com/linux-security-mistakes ### Arch Linux - **Arch Server Setup**: This command installs a minimal arch server setup under 5 minutes. -- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. -To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers -- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go. -To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers +- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers +- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers ### Fedora - **Configure DNF**: Optimizes DNF for parallel downloads - **Multimedia Codecs**: This script is designed to install multimedia codecs, and to ensure RPM Fusion repositories are installed. - **Nvidia Proprietary Drivers**: This script is designed to download the proprietary NVIDIA drivers in Fedora. -- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. -That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. -For more information visit: https://rpmfusion.org/ +- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. For more information visit: https://rpmfusion.org/ - **Upgrade to a New Fedora Release**: Upgrades system to the next Fedora release - **Virtualization**: Enables Virtualization through dnf - **Build Prerequisites**: This script is designed to handle the installation of various software dependencies across different Linux distributions