add new README for binaries
This commit is contained in:
parent
5fcb5681f7
commit
e15c7be234
1 changed files with 18 additions and 0 deletions
18
bin/README.md
Normal file
18
bin/README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# Binaries for running ArchiveBox
|
||||||
|
|
||||||
|
This folder contains all the executables that ArchiveBox provides.
|
||||||
|
|
||||||
|
|
||||||
|
# Adding it to your `$PATH`
|
||||||
|
To be able to run ArchiveBox from anywhere on your system, you can add this entire folder to your path, like so:
|
||||||
|
|
||||||
|
**Edit `~/.bash_profile`:**
|
||||||
|
```bash
|
||||||
|
export PATH=/opt/ArchiveBox/bin:$PATH
|
||||||
|
```
|
||||||
|
|
||||||
|
# Running executables directly
|
||||||
|
|
||||||
|
If you don't want to add ArchiveBox to your `$PATH` you can also call these executables directly with their full path, like so:
|
||||||
|
|
||||||
|
`/opt/ArchiveBox/bin/ArchiveBox https://example.com/some/feed.rss`
|
Loading…
Reference in a new issue