diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index c41b796..148f316 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -33,45 +33,16 @@ export default { ], sidebar: [ { text: "Introduction", link: "/getting-started/introduction" }, - { - text: "Installation", - collapsible: true, - collapsed: false, - items: [ - { text: "Terminal", link: "/installation/cli" }, - { text: "Commands", link: "/installation/cmd" }, - { text: "TUI", link: "/installation/tui" }, - { text: "PKG Build", link: "/installation/pkg" }, - ], - }, - { - text: "Utilities", - collapsible: true, - collapsed: false, - items: [ - { text: "Overview Scripts", link: "/scripts/scripts" }, - ], - }, - { - text: "Collaboration", - collapsible: true, - collapsed: false, - items: [ - { text: "Roadmap", link: "/github/roadmap" }, - { text: "Contributing", link: "/github/contributing" }, - { text: "Code of Conduct", link: "/github/codeofconduct" }, - ], - }, - { - text: "Acknowledgment", - collapsible: true, - collapsed: false, - items: [ - { text: "Inspiration", link: "/acknowledgment/inspiration" }, - { text: "Contributions", link: "/acknowledgment/contributors" }, + { text: "Installation", link: "/installation/cli" }, + { text: "Commands", link: "/installation/cmd" }, + { text: "TUI", link: "/installation/tui" }, + { text: "Overview Scripts", link: "/scripts/scripts" }, + { text: "Roadmap", link: "/github/roadmap" }, + { text: "Contributing", link: "/github/contributing" }, + { text: "Code of Conduct", link: "/github/codeofconduct" }, + { text: "Inspiration", link: "/acknowledgment/inspiration" }, + { text: "Contributions", link: "/acknowledgment/contributors" }, ], - }, -], socialLinks: [ { icon: "telegram", link: "https://t.me/carchx" }, { icon: "discord", link: "https://discord.com/invite/8NJWstnUHd" }, diff --git a/docs/installation/cli.md b/docs/installation/cli.md index 1100b86..216b797 100644 --- a/docs/installation/cli.md +++ b/docs/installation/cli.md @@ -4,22 +4,28 @@ **To install Carch, execute the following command in your terminal:** > [!INFO] -> **Make sure to install `curl` before running this command** **`sudo pacman -S curl`** +> **Make sure to install `curl` before running this command:** **`sudo pacman -S curl`** or **`sudo dnf install curl -y`** +> +> **Also, check the `make` and `less` packages (for Arch only).** :::code-group -```sh [Install] -bash <(curl -L https://chalisehari.com.np/carchx) +```sh [ Arch] +bash <(curl -L https://chalisehari.com.np/arch) ``` -```sh [Run] -carch +```sh [ Fedora] +bash <(curl -L https://chalisehari.com.np/fedora) ``` :::tip :bulb: TIP You don't need to run the installation script every time. You can run it once, and then simply type carch in your terminal whenever you want to automatically execute the Carch script.

If the installation command fails, you can try running
-`curl -fsSL https://chalisehari.com.np/carchx | sh` +`curl -fsSL https://chalisehari.com.np/arch | sh` + +or + +`curl -fsSL https://chalisehari.com.np/fedora | sh` ::: diff --git a/docs/installation/pkg.md b/docs/installation/pkg.md deleted file mode 100644 index 163d280..0000000 --- a/docs/installation/pkg.md +++ /dev/null @@ -1,37 +0,0 @@ -
- -# [`Carch Aur Packages`](https://github.com/carch-org/pkgs) - -
- - -> [!IMPORTANT] -> Installing or uploading packages that act as installer scripts or customize the system in a way that diverges from the official guidelines is not allowed on the AUR. -> -> As such, the package has been removed from the AUR. I respect the AUR guidelines, and I encourage you to check the main Carch project for alternative installation methods. Thank you! - -> [!NOTE] -> Carch is not available on the AUR because it is a script. However, you can use the provided package build to run Carch as a package, similar to an AUR package, or visit the Carch documentation for the CLI installer. - -*Assuming, You have already install dependency like: `make` & `git`* - -### 📦 Package Build [ Stable ] - -```sh [Package Build ] -git clone https://github.com/carch-org/pkgs -cd pkgs/carch -makepkg -si -``` - -### 📦 Git Package Build [ Latest Git-Build ] - -```sh [Git Package Build ] -git clone https://github.com/carch-org/pkgs -cd pkgs/carch-git -makepkg -si -``` - -> [!NOTE] -> You can use the `carch` package for stable updates with the latest release, or use the `git package` to get the most recent changes directly from the Carch GitHub repository. -> -> And please don't mix up the installation methods. Stick to either the `PKGBUILD` or the `CLI` installation. diff --git a/docs/installation/tui.md b/docs/installation/tui.md index 36ad0be..4dd9bee 100644 --- a/docs/installation/tui.md +++ b/docs/installation/tui.md @@ -18,92 +18,9 @@ Keep in mind, the TUI is still in development, so bugs might pop up. If you find Lastly, a big thank you to [`ChrisTitusTech`](https://github.com/ChrisTitusTech) and the [`Contributors`](https://github.com/ChrisTitusTech/linutil/graphs/contributors). Your work in the Linux community is amazing, and I’m grateful to have been able to use your project as part of mine. +### Installation -## Installation - -TUI - -### Install TUI Directly from the GitHub Repository - -Run the following command to download and use the TUI directly: - -```sh -bash <(curl -L https://chalisehari.com.np/carchtui) -``` - -
- -TUI - -### Install Using the Main Script - -This will download the TUI along with the main script. Once installed, you can run the TUI using: -- `carch --tui` -- `carch -t` - -First, install `carch` by running: - -```sh -bash <(curl -L https://chalisehari.com.np/carchx) -``` - -
- -TUI - -### Customize with `.toml` Files - -The TUI supports custom `.toml` files for executing specific commands. -Here’s an example `carch.toml` configuration: - -```toml -# example carch.toml - -auto_execute = [ - "Communication Apps", - "Android", - "Thunar" -] -``` - -
- -TUI - -### **Usage** - -#### 🗂 Specify Your Configuration File - -Save your `.toml` configuration file at: -`~/.config/carch/carch.toml` - -To execute the commands in the order specified in your `.toml` file, run: - -```sh -carch-tui --config ~/.config/carch/carch.toml -``` - -This will execute the commands in the order you have specified in the `.toml` file. +**To install, use the main script available [here](https://carch-org.github.io/docs/installation/cli.html).** > [!NOTE] > This TUI is an **optional feature** for a more user-friendly experience.