Merge branch 'main' of github.com:khyerdev/tcobalt

README.md

@@ -1,4 +1,4 @@
-# tcbobalt Command Line Utility
+# tcobalt Command Line Utility
 
 tcobalt (or tcb) is a command-line tool for downloading your favorite videos and audios from the internet. This tool uses the api of [wukko](https://github.com/wukko)'s [cobalt.tools](https://cobalt.tools), which is an amazing website to save what you love without ads, trackers, or anything creepy.
 <img src=https://github.com/OSCH2008/tcobalt/assets/82794982/f12acec9-c668-4b8b-819c-1256fe802915 style="width: 100%"></img>
@@ -45,18 +45,55 @@ tcobalt also supports `tcb --help`, `tcb -h`, `tcb --version`, and `tcb -v` for
 ## Support
 As of now, tcobalt only officially supports the x86_64 architecture, but it can theoretically compile and run on others. If tcobalt compiles and runs well on your machine with a different architecture, open up an issue.
 
-tcobalt currently is not in any package repository.
+tcobalt has only been packaged for Arch Linux and it's derivatives
 
-### Support roadmap
-1. Arch Linux (and its derivatives)
-2. i686, pentium4, and aarch64 architectures
-3. Debian (and its derivatives)
-4. Windows 10/11
-5. (if i can do this with flatpak) other distros
-6. MacOS
+### Distro Support roadmap
+1. Arch Linux (and its derivatives) (DONE)
+2. Debian (and its derivatives)
+3. Windows 10/11
+4. (if i can do this with flatpak) other distros
+5. MacOS
+
+### Architecture Support Progress
+As of now, the PKGBUILD for tcobalt on the AUR only has 'x86_64' in the arch array, but someone I know was able to install it on their aarch64 system right from the AUR
+1. x86_64 - YES
+2. aarch64 - Compiled
+3. i686 - Not Tested
+4. pentium4 - Not Tested
 
 ## Installation
-This section will be made later, compile this yourself using cargo
+Make sure you have rust version 1.77.0 or higher before installing
+### Arch Linux
+1. Install `yay` or `paru`:
+   ```sh
+   sudo pacman -S base-devel
+   git clone https://aur.archlinux.org/yay.git # or paru.git
+   cd yay # or paru
+   makepkg -si
+   ```
+2. Use either `yay` or `paru` to install `tcobalt`:
+   ```
+   yay -S tcobalt
+   ```
+   ```
+   paru -S tcobalt
+   ```
+This process will also work on arch-based distros. On Manjaro, run `pamac install` instead of `pacman -S`
+
+### Other / unsupported
+More support will come later. If you are on an unsupported operating system, do this:
+1. Clone the repository
+   ```
+   git clone https://github.com/khyerdev/tcobalt.git
+   cd tcobalt
+   ```
+2. Compile with `cargo` (make sure rust is installed and the default rust toolchain is also installed)
+   ```
+   cargo build --release
+   ```
+3. Copy the `target/release/tcobalt` binary to a directory included in your `$PATH` (`%PATH%` on Windows)
+4. Create a symbolic link named `tcb` in the same directory you put `tcobalt` that points to that `tcobalt` binary
+   On windows, you would create a batch file in a `%PATH%` folder named `tcb.bat` that would just run the `tcobalt.exe` binary, or just completely rename the binary to `tcb.exe`
 
 ## Dependencies
 tcobalt is designed to use as little dependencies as possible. Here are the ones it uses: