diff --git a/search/search_index.json b/search/search_index.json index 734c2ad1..d4dae6dc 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":"

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contribute/","title":"How to Contribute?","text":"

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

"},{"location":"contribute/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contribute/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":""},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":""},{"location":"contribute/#10-documentation","title":"10. Documentation","text":""},{"location":"contribute/#11-license","title":"11. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-setup","title":"Arch Setup","text":""},{"location":"userguide/#fedora-setup","title":"Fedora Setup","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#security-features","title":"Security Features","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":"

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contribute/","title":"How to Contribute?","text":"

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

"},{"location":"contribute/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contribute/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":""},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":""},{"location":"contribute/#10-documentation","title":"10. Documentation","text":""},{"location":"contribute/#11-license","title":"11. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-setup","title":"Arch Setup","text":""},{"location":"userguide/#fedora-setup","title":"Fedora Setup","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#security-features","title":"Security Features","text":""},{"location":"userguide/#utilities","title":"Utilities","text":""}]} \ No newline at end of file diff --git a/userguide/index.html b/userguide/index.html index 2fbd347c..30b691ec 100644 --- a/userguide/index.html +++ b/userguide/index.html @@ -1 +1 @@ - User Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

Walkthrough


System Setup

  • System Update: Starts a system-wide update.
  • Compile Setup: Installs tools and dependencies for compiling software.
  • Gaming Setup: Configures Steam, Lutris, etc.
  • Global Theming: Sets up and manages global themes.
  • Remove Snaps: Removes snap packages.

Arch Setup

  • Paru Setup: Installs the Paru AUR helper.
  • Yay Setup: Installs the Yay AUR helper.
  • Server Setup: Installs Arch Linux.

Fedora Setup

  • RPM Fusion Setup: Adds RPM Fusion repositories.

Applications Setup

  • Alacritty Setup: Installs and configures Alacritty for you.
  • DwmTitus Setup: Sets up the Dwm window manager.
  • Kitty Setup: Installs and configures Kitty for you.
  • Rofi Setup: Installs the Rofi application/script launcher.
  • Zsh Setup: Installs and configures Zsh for you.

Security Features

  • Firewall Baselines: Sets up firewall rules.
\ No newline at end of file + User Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

Walkthrough


System Setup

  • System Update: Starts a system-wide update.
  • Compile Setup: Installs tools and dependencies for compiling software.
  • Gaming Setup: Configures Steam, Lutris, etc.
  • Global Theming: Sets up and manages global themes.
  • Remove Snaps: Removes snap packages.

Arch Setup

  • Paru Setup: Installs the Paru AUR helper.
  • Yay Setup: Installs the Yay AUR helper.
  • Server Setup: Installs Arch Linux.

Fedora Setup

  • RPM Fusion Setup: Adds RPM Fusion repositories.

Applications Setup

  • Alacritty Setup: Installs and configures Alacritty for you.
  • DwmTitus Setup: Sets up the Dwm window manager.
  • Kitty Setup: Installs and configures Kitty for you.
  • Rofi Setup: Installs the Rofi application/script launcher.
  • Zsh Setup: Installs and configures Zsh for you.

Security Features

  • Firewall Baselines: Sets up firewall rules.

Utilities

  • Monitor Control: Controls monitor settings on X11.
  • Bluetooth Control: Controls Bluetooth settings.
  • Wifi Control: Controls WiFi settings.
  • Numlock Control: Sets up Numlock on boot.
  • User Account Manager: Manage users and groups.
\ No newline at end of file