Skip to content

Commit

Permalink
docs: Update README with shields and macOS installation info
Browse files Browse the repository at this point in the history
  • Loading branch information
yellow-footed-honeyguide committed Oct 15, 2024
1 parent d629c48 commit 4b8c123
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# facad

[![Documentation](https://img.shields.io/badge/documentation-doxygen-f5b836.svg)](https://yellow-footed-honeyguide.github.io/facad/)
[![versions](https://img.shields.io/repology/repositories/facad?color=f5b836)](https://repology.org/project/facad/versions)

A modern, colorful directory listing tool for the command line.

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


## Features
> Designed for both novice users and power users,<br>
> facad feature set aims to enhance file management experience with<br>
Expand All @@ -21,37 +25,36 @@ A modern, colorful directory listing tool for the command line.
### Dependencies
- Pure C implementation without any dependency

### macOS
facad is available through Homebrew. To install, run:
```bash
brew install facad
```

### I use Arch btw?
Just use the script from AUR:
```bash
yay -S facad
```

### Build
### Build & Install from source
```bash
git clone https://github.com/yellow-footed-honeyguide/facad.git
cd facad
mkdir build && cd build
meson setup .. && ninja
```

### Install
For system-wide installation (may require elevated privileges like `sudo`):
```bash
# for system-wide installation (may require elevated privileges like `sudo`):
sudo ninja install
```

## Usage

Run `facad` command for default grid file listing
Run `facad -h/--help` command for help
Run `facad -v--version` command for version
Run `facad -l/--long` command for long listing output
Run `facad -a/--analytics` command for dir analytics output

Run `facad -l` command for long listing output

Run `facad -a` command for dir analytics output

Run `facad -h` command for help

Run `facad -v` command for version


## Contributing
Expand Down

0 comments on commit 4b8c123

Please sign in to comment.