exquisitecorp
/
bookmobile
2
1
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

update README.md

This commit is contained in:
lee2sman 2022-01-14 14:00:41 -05:00
parent c43b775923
commit e0d111b050
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -74,11 +74,21 @@ Options:
The themes subdirectory contains several custom simple themes for rendering a nice reader view. You can edit or add themes here and they will display in the usage help.
## Shortcuts
### Fish shell function
I use the Fish Shell, an alternative to BASH.
Fish allows use of Functions, which are mostly equivalent to Bash aliases, which let you make easy-to-type shortcuts in the command line.
Since my most common workflow is to download an article and save as an epub, I created the epubmobile shortcut. If you use fish shell you can move to your ```~/.config/fish/functions/``` folder. Be sure to edit the file to match your own paths. The first path should match the location of bookmobile on your system, and the next should indicate where you want your epubs to automatically be placed. Make sure the original bookmobile is executable on your system using chmod + x.
### GUI
A simple yad-based GUI application is included as well.
To install on Debian/*buntu-based systems: ```apt install yad```.
To install on Debian/*buntu-based systems: ```apt install yad```. Then ```chmod +x bookmobile.gui``` to make it executable.
It can be launched from the command line with ```./bookmobile-gui``` or you can create an [executable](https://askubuntu.com/questions/64222/how-can-i-create-launchers-on-my-desktop/66918#66918).