onipa/pdf2book
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md: add info about install script

Browse Source
This commit is contained in:
uni@bor.mac 2025-06-09 23:14:34 +02:00
parent 4402e6b2e3
commit 8bee5aa974
2 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -2,7 +2,7 @@
CLI script to rearrange pdf pages for printing book signatures and foldable zines CLI script to rearrange pdf pages for printing book signatures and foldable zines
## INSTALL pdf2book in Linux or macOS ## Install pdf2book in Linux or macOS
### Dependencies: ### Dependencies:
- [`bash`](https://www.gnu.org/software/bash/) (mostly already installed) - [`bash`](https://www.gnu.org/software/bash/) (mostly already installed)
@ -12,6 +12,30 @@ CLI script to rearrange pdf pages for printing book signatures and foldable zine
- [`venv`](https://docs.python.org/3/library/venv.html) (might be installed) - [`venv`](https://docs.python.org/3/library/venv.html) (might be installed)
- check with `python3 -m venv --help` - check with `python3 -m venv --help`
### Installation script
use the installation script
```bash
# create temporary directory
TMPDIR=$(mktemp -d)
# change into temporary dir
pushd $TMPDIR
# clone pdf2book source code
git clone https://git.wlankabel.at/onipa/pdf2book.git
# change into pdf2book directory
pushd pdf2book
# show help message of install script
bash install.sh -h
# execute interactive install script
bash install.sh
# change to previous folder
popd
popd
# remove temporary folder
rm -rf $TMPDIR
```
### install manually
```bash ```bash
#!/bin/bash #!/bin/bash
PREFIX="$HOME/.local" PREFIX="$HOME/.local"

7
install.sh
View File

@ -17,7 +17,7 @@ HELP="""
$0: install pdf2book with its virtual environment $0: install pdf2book with its virtual environment
usage: usage:
-h|--help show this help message and exti -h|--help show this help message and exti
-d|--delete remove pdf2book -d|--delete remove pdf2book installation
-f|--force force overwriting of PREFIX/lib/pdf2book.git -f|--force force overwriting of PREFIX/lib/pdf2book.git
can be used for upgrading can be used for upgrading
-p|--prefix PREFIX install into PREFIX/lib and PREFIX/bin -p|--prefix PREFIX install into PREFIX/lib and PREFIX/bin
@ -30,6 +30,11 @@ while [[ $# -gt 0 ]]; do
case "$1" in case "$1" in
--delete|-d) --delete|-d)
DELETE=1 DELETE=1
echo 'THIS DOES NOTHING AT THE MOMENT ...'
echo 'todo:'
echo " - [ ] remove $PREFIX/pdf2book.git"
echo " - [ ] and clean your ~/.bashrc or ~/.zshrc"
exit 0
;; ;;
--force|-f) --force|-f)
FORCE=1 FORCE=1