Skip to content

Commit 3620033

Browse files
docs: Update README with shields and macOS installation info
1 parent d629c48 commit 3620033

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# facad
22

3+
[![Documentation](https://img.shields.io/badge/documentation-doxygen-f5b836.svg)](https://yellow-footed-honeyguide.github.io/facad/)
4+
[![versions](https://img.shields.io/repology/repositories/facad?color=f5b836)](https://repology.org/project/facad/versions)
5+
36
A modern, colorful directory listing tool for the command line.
47

58
![facad in action](assets/facad_2_18.jpg)
69

10+
711
## Features
812
> Designed for both novice users and power users,<br>
913
> facad feature set aims to enhance file management experience with<br>
@@ -21,23 +25,25 @@ A modern, colorful directory listing tool for the command line.
2125
### Dependencies
2226
- Pure C implementation without any dependency
2327

28+
### macOS
29+
facad is available through Homebrew. To install, run:
30+
```bash
31+
brew install facad
32+
```
33+
2434
### I use Arch btw?
2535
Just use the script from AUR:
2636
```bash
2737
yay -S facad
2838
```
2939

30-
### Build
40+
### Build & Install from source
3141
```bash
3242
git clone https://github.com/yellow-footed-honeyguide/facad.git
3343
cd facad
3444
mkdir build && cd build
3545
meson setup .. && ninja
36-
```
37-
38-
### Install
39-
For system-wide installation (may require elevated privileges like `sudo`):
40-
```bash
46+
# for system-wide installation (may require elevated privileges like `sudo`):
4147
sudo ninja install
4248
```
4349

0 commit comments

Comments
 (0)