1
0
Fork 0

add new README for binaries

This commit is contained in:
Nick Sweeting 2018-12-21 18:18:19 -05:00 committed by GitHub
parent 5fcb5681f7
commit e15c7be234
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

18
bin/README.md Normal file
View 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`