update README.md
This commit is contained in:
parent
8453232128
commit
1231a910d6
|
@ -0,0 +1,31 @@
|
|||
# Bookmobile
|
||||
|
||||
Command line software written in fishscript (shell), for saving articles for offline viewing as epubs, markdown and in a simple reader view webpage.
|
||||
|
||||
This software is currently in-progress. Expect some warts.
|
||||
|
||||
### Install
|
||||
|
||||
```
|
||||
git clone https://tildegit.org/exquisitecorp/bookmobile.git
|
||||
cd bookmobile
|
||||
chmod +x bookmobile.fish
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```
|
||||
./bookmobile.fish URL
|
||||
```
|
||||
|
||||
The original URL article's HTML will be saved to originals. An epub, markdown, and a simplified reader view will be placed in their respective folders.
|
||||
|
||||
### Dependencies
|
||||
|
||||
- fish
|
||||
- Pandoc>2.0
|
||||
- Lua
|
||||
- wget
|
||||
|
||||
### TODO
|
||||
- [ ] Clean up reader view - strip out as much cruft (headers, footers) as possible
|
Loading…
Reference in New Issue