Skip to content

Commit 4b7f678

Browse files
authored
Merge pull request #159 from xscriptor/update/install-docs
update install-docs
2 parents 7423ab5 + 497998e commit 4b7f678

7 files changed

Lines changed: 1254 additions & 564 deletions

File tree

README.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<li><a href="#previews">Previews <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/device-camera.svg"/></a></li>
2020
<li><a href="#quick-install">Quick Install </a><img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/pass-filled.svg"/></li>
2121
<li><a href="#features">Features </a><img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/grabber.svg" /></li>
22-
<li><a href="#installation">Installation </a><img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/github-action.svg" /></li>
22+
<li><a href="#quick-install">Installation </a><img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/github-action.svg" /></li>
2323
<li><a href="#configuration">Configuration </a> <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/gear.svg" /></li>
2424
<li><a href="#usage">Usage </a> <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/flame.svg"/></li>
2525
<li><a href="#related-documents">Related Documents </a>
@@ -66,42 +66,24 @@
6666

6767
<h2 id="quick-install" align="center"> Quick Install</h2>
6868

69-
<h3> Linux <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/terminal-linux.svg" /> / <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/terminal.svg" /> macOS </h3>
70-
69+
**Linux / macOS:**
7170
```bash
7271
curl -fsSL https://raw.githubusercontent.com/xscriptor/xfetch/main/install.sh | bash
7372
```
7473

75-
<h3> Windows (PowerShell) <img src="https://xscriptor.github.io/icons/icons/code/product-design/xsvg/terminal-powershell.svg" /></h3>
76-
74+
**Windows (PowerShell):**
7775
```powershell
7876
irm https://raw.githubusercontent.com/xscriptor/xfetch/main/install.ps1 | iex
7977
```
8078

79+
> For detailed installation steps — prerequisites, manual builds, package managers, and uninstallation — see the [Installation Guide](docs/INSTALLATION.md).
80+
8181
<h2 id="features" align="center"> Features</h2>
8282

8383
- **Cross-platform**: Works on Linux, Windows, and macOS.
8484
- **Customizable**: Configure modules via `config.jsonc`.
8585
- **Fast**: Written in Rust for performance.
8686

87-
<h2 id="installation" align="center"> Installation </h2>
88-
89-
<h3> From Source </h3>
90-
91-
1. Ensure you have Rust installed.
92-
2. Clone the repository.
93-
3. Build and run:
94-
95-
```bash
96-
cargo run --release
97-
```
98-
99-
Or install locally:
100-
101-
```bash
102-
cargo install --path .
103-
```
104-
10587
<h2 id="configuration" align="center"> Configuration </h2>
10688

10789
xfetch looks for a configuration file at:

0 commit comments

Comments
 (0)