swadhin / fetchx public

docs(readme): finalize README with SEO, gallery, and star history

Swadhin Biswas committed 7 months ago
b9f70e1
1 parent 01fd6d6
commit b9f70e1
1 file changed
+115 -0
Showing 1 changed file+115-0
README.md
▼README.md
+115-0
@@ -948,3 +948,118 @@ Android · macOS · Windows
948
948
---
949
949
950
950
## Dependencies
951
+
952
+### Build Dependencies
953
+
954
+| Dependency | Purpose |
955
+| ---------- | -------------------- |
956
+| `rustc` | Rust compiler |
957
+| `cargo` | Rust package manager |
958
+| `git` | Clone source |
959
+
960
+### Runtime Dependencies
961
+
962
+**None required!** FetchX is a statically-linked binary.
963
+
964
+### Optional Runtime Dependencies
965
+
966
+| Package | Purpose | Install (Arch/CachyOS) |
967
+| ---------------------- | ------------------------ | ----------------------- |
968
+| `chafa` | Chafa image backend | `pacman -S chafa` |
969
+| `img2sixel` (libsixel) | Sixel image backend | `pacman -S libsixel` |
970
+| `w3m` | w3m image backend | `pacman -S w3m` |
971
+| `fzf` | Interactive image picker | `pacman -S fzf` |
972
+| `playerctl` | Song/MPRIS detection | `pacman -S playerctl` |
973
+| `xrandr` | Resolution (X11) | `pacman -S xorg-xrandr` |
974
+| `wlr-randr` | Resolution (Wayland) | `pacman -S wlr-randr` |
975
+| `hyprctl` | Resolution (Hyprland) | Included with Hyprland |
976
+
977
+---
978
+
979
+## Uninstalling
980
+
981
+### Using the install script:
982
+
983
+```bash
984
+./install.sh --uninstall
985
+```
986
+
987
+### Manual removal:
988
+
989
+```bash
990
+# Remove binary
991
+rm ~/.local/bin/fetchx # user install
992
+# or
993
+sudo rm /usr/local/bin/fetchx # system install
994
+
995
+# Remove config (optional)
996
+rm -rf ~/.config/fetchx
997
+
998
+# Remove cache (optional)
999
+rm -rf ~/.cache/fetchx
1000
+
1001
+# Remove aliases from your shell config
1002
+# Edit ~/.bashrc, ~/.zshrc, or ~/.config/fish/config.fish
1003
+# and remove the fetchx alias lines
1004
+```
1005
+
1006
+---
1007
+
1008
+## Contributing
1009
+
1010
+Contributions are welcome! Here's how to get started:
1011
+
1012
+```bash
1013
+git clone https://github.com/swadhinbiswas/fetchx.git
1014
+cd fetchx/fetchx
1015
+cargo test # Run 45 unit tests
1016
+cargo build # Debug build
1017
+cargo build --release # Release build
1018
+```
1019
+
1020
+Areas where help is most needed:
1021
+
1022
+1. **ASCII art** — Port more distro logos from neofetch
1023
+2. **macOS / BSD** — Testing and detection improvements
1024
+3. **Windows (WSL)** — Compatibility testing
1025
+4. **Package managers** — More package manager detection
1026
+
1027
+---
1028
+
1029
+## Star History
1030
+
1031
+If FetchX is useful to you, consider giving it a ⭐ — it helps others discover it!
1032
+
1033
+<p align="center">
1034
+ <a href="https://github.com/swadhinbiswas/fetchx/stargazers">
1035
+ <img src="https://img.shields.io/github/stars/swadhinbiswas/fetchx?style=for-the-badge&logo=github&color=yellow" alt="Star FetchX on GitHub">
1036
+ </a>
1037
+</p>
1038
+
1039
+---
1040
+
1041
+## License
1042
+
1043
+MIT — see [LICENSE](LICENSE) for details.
1044
+
1045
+## Acknowledgments
1046
+
1047
+- [Neofetch](https://github.com/dylanaraps/neofetch) — Original inspiration and ASCII art reference
1048
+- [FastFetch](https://github.com/fastfetch-cli/fastfetch) — Performance inspiration
1049
+- [Nerd Fonts](https://www.nerdfonts.com/) — Icon support
1050
+
1051
+---
1052
+
1053
+<p align="center">
1054
+ <sub>Made with ❤️ and 🦀 Rust</sub>
1055
+ <br>
1056
+ <sub>FetchX is a <b>neofetch alternative</b> — a fast system info tool for Linux, macOS, and BSD.</sub>
1057
+ <br>
1058
+ <sub>Perfect for <a href="https://www.reddit.com/r/unixporn/">r/unixporn</a> screenshots, dotfiles, and terminal ricing.</sub>
1059
+</p>
1060
+
1061
+<!-- SEO: neofetch alternative, neofetch replacement, neofetch rust, system fetch tool,
1062
+ terminal system info, linux fetch, ascii art terminal, kitty image protocol,
1063
+ rust cli tool, fast neofetch, screenfetch alternative, pfetch alternative,
1064
+ macchina alternative, fastfetch alternative, unixporn, dotfiles, ricing,
1065
+ system information display, terminal customization -->
951
1066