huncholanedocs: table of contents, more links, and program details
huncholane1 file changed, +76 -11
+76-11README.md
| @@ -3,23 +3,88 @@ | ||
| 3 | 3 | Tired of reconfiguring mandatory programs over and over on new systems. This |
| 4 | 4 | one line install script fixes up a system to become a developement power house. |
| 5 | 5 | |
| 6 | +## Oneline Installer | |
| 7 | + | |
| 6 | 8 | ```sh |
| 7 | 9 | curl -fsSL https://raw.githubusercontent.com/huncholane/dotzsh/main/install.sh | bash |
| 8 | 10 | ``` |
| 9 | 11 | |
| 12 | +## Table of Contents | |
| 13 | + | |
| 14 | +- [Programs Installed](#programs-installed) | |
| 15 | +- [Program Details](#program-details) | |
| 16 | + - [Essentials](#essentials) | |
| 17 | + - [Rust Related](#rust-related) | |
| 18 | + - [Go Related](#go-related) | |
| 19 | +- [Antidote Plugins](#antidote-plugins) | |
| 20 | +- [Test Installer](#test-installer) | |
| 21 | + | |
| 10 | 22 | ## Programs Installed |
| 11 | 23 | |
| 12 | -| Program | Installer | Description | System | | |
| 13 | -|---------|-----------|-------------|--------| | |
| 14 | -| [git](https://git-scm.com/install/linux) | System | Repo management | All | | |
| 15 | -| [base-devel](https://archlinux.org/packages/core/any/base-devel/) | System | Developer tools | Arch | | |
| 16 | -| [go](https://go.dev/doc/install) | Binary | Programming language also used to install some programs | All | | |
| 17 | -| [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) | Install Script | Used for rust, also used to install some programs | All | | |
| 18 | -| [lsd](https://github.com/lsd-rs/lsd) | cargo | Adds icons to ls | All | | |
| 19 | -| [lazygit](https://github.com/jesseduffield/lazygit) | Binary | Best way to use git by far | All | | |
| 20 | -| [fnm](https://github.com/Schniz/fnm) | Install Script | Node manager written in rust | All | | |
| 21 | -| [uv](https://docs.astral.sh/uv/getting-started/installation/) | Install Script | Python environment manager written in rust | All | | |
| 22 | -| [yazi](https://github.com/sxyazi/yazi/releases/tag/v26.1.22) | Binary | Miller pane tui file explorer | All | | |
| 24 | +| Program | Installer | Description | | |
| 25 | +|---------|-----------|-------------| | |
| 26 | +| [base-devel](https://archlinux.org/packages/core/any/base-devel/) | System | Developer tools for arch systems (gcc/g++, make, binutils, libc headers, patch, fakeroot, pkgconf) | | |
| 27 | +| [build-essential](https://itsfoss.com/build-essential-ubuntu/) | System | Developer tools for debian systems (gcc/g++, make, binutils, libc headers, patch, fakeroot, pkgconf) | | |
| 28 | +| [git](https://git-scm.com/) | [System](https://git-scm.com/install/linux) | Repo management | | |
| 29 | +| [cargo](https://doc.rust-lang.org/cargo/) | [Install Script](https://doc.rust-lang.org/cargo/getting-started/installation.html) | Used for rust, also used to install some programs | | |
| 30 | +| [lsd](https://github.com/lsd-rs/lsd) | Cargo | Adds icons to ls | | |
| 31 | +| [go](https://go.dev/) | [Binary](https://go.dev/doc/install) | Programming language also used to install some programs | | |
| 32 | +| [fzf](https://github.com/junegunn/fzf) | [Git](https://github.com/junegunn/fzf) | Used in several programs to fuzzy find | | |
| 33 | +| [lazygit](https://github.com/jesseduffield/lazygit) | [Binary](https://github.com/jesseduffield/lazygit?tab=readme-ov-file#go) | Best way to use git by far (written in go) | | |
| 34 | +| [fnm](https://github.com/Schniz/fnm?tab=readme-ov-file#using-a-script-macoslinux) | [Install Script](https://github.com/Schniz/fnm) | Node version manager written in rust | | |
| 35 | +| [uv](https://docs.astral.sh/uv/) | [Install Script](https://docs.astral.sh/uv/getting-started/installation/) | Python environment manager written in rust | | |
| 36 | +| [yazi](https://yazi-rs.github.io/docs/quick-start) | [Binary](https://github.com/sxyazi/yazi/releases/tag/v26.1.22) | Miller pane tui file explorer | | |
| 37 | + | |
| 38 | +## Program Details | |
| 39 | + | |
| 40 | +### Essentials | |
| 41 | + | |
| 42 | +**base-devel/build-essential - Must have** | |
| 43 | + | |
| 44 | +Allows C/C++/Assembly programs work smoothly. | |
| 45 | + | |
| 46 | +**git - Repo management** | |
| 47 | + | |
| 48 | +Manages repos. This is used heavily for installing programs. Also used a ton as a developer. | |
| 49 | + | |
| 50 | +### Rust Related | |
| 51 | + | |
| 52 | +**cargo - Rust** | |
| 53 | + | |
| 54 | +Rust manager that comes with rustup. Used for installing lsd. Also used with `nightly` to install blink in nvim. Essential for rust development. | |
| 55 | + | |
| 56 | +**lsd - Pretty ls** | |
| 57 | + | |
| 58 | +Pretty ls output. Alias `l` for `ls` with icons and `ll` for `ls -l` with icons. | |
| 59 | + | |
| 60 | +**fnm - Node version management** | |
| 61 | + | |
| 62 | +Node management written in rust. A much faster version of nvm. Alias `nvm` since it is muscle memory and fnm should be used instead for performance. | |
| 63 | + | |
| 64 | +**uv - Python evironment management** | |
| 65 | + | |
| 66 | +This one is interesting. This config sets up a a python environment in | |
| 67 | +`$HOME/.venv` and gets sourced automatically. This plays very nice with the | |
| 68 | +`zsh-auto-switch-vertialenv` plugin. Any directory with `.venv` in it will | |
| 69 | +automatically be sourced upon entry. It's like conda but faster and | |
| 70 | +automatically focused on the current directory. | |
| 71 | + | |
| 72 | +**yazi - Miller pane tui file explorer** | |
| 73 | + | |
| 74 | +A file explorer that looks like the mac file explorer using miller panes. This | |
| 75 | +one doesn't have a very good universal way to install, so the install script | |
| 76 | +makes installation smoother by determining architecture, download from github | |
| 77 | +release, and copy the binaries into `/usr/local/bin`. | |
| 78 | + | |
| 79 | +### Go Related | |
| 80 | + | |
| 81 | +**go - Programming language created by Google** | |
| 82 | + | |
| 83 | +Some of the programs are installed using go. This is installed by checking the latest version online and installing for the detected architecture. The package is untarred into `/usr/local/go` and `/usr/local/go/bin` is added to the `PATH`. | |
| 84 | + | |
| 85 | +**lazygit - The most incredible way to use git** | |
| 86 | + | |
| 87 | +A tui to represent git and all of it's beauty written and installed through go. Used heavily in tmux with `prefix-G` on [dotmux](https://github.com/huncholane/dotmux). | |
| 23 | 88 | |
| 24 | 89 | ## Antidote Plugins |
| 25 | 90 |