Skip to content
This repository has been archived by the owner on Nov 26, 2023. It is now read-only.

Commit

Permalink
📝 Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Beta Pictoris authored Apr 9, 2022
1 parent 8f9401c commit e13f826
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Wiki CLI
View Wikipedia articles through the CLI

## Installation
### From release
```bash
curl -LO https://github.com/BetaPictoris/wiki/releases/latest/download/wcli # Download the latest binary.
sudo install -Dt /usr/local/bin -m 755 wiki # Install Wiki CLI to "/usr/local/bin" with the mode "755"
```

### Build from source
```bash
git clone [email protected]:BetaPictoris/wcli.git # Clone the repository
cd wiki # Change into the repository's directory
bash build.sh # Build Wiki CLI
sudo install -Dt /usr/local/bin -m 755 wiki # Install Wiki CLI to "/usr/local/bin" with the mode "755"
```

### User install
If you don't have access to `sudo` on your system you can install to your user's `~/.local/bin` directory with this command:
```bash
install -Dt ~/.local/bin -m 755 wiki
```

0 comments on commit e13f826

Please sign in to comment.