new: Added a README

This commit is contained in:
Sayantan Santra 2025-04-18 02:25:53 -05:00
parent bbe6ccd7df
commit b9ba7fab7e
Signed by: SinTan1729
GPG key ID: 0538DD402EA50898

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Cambridge Core Merge
This is a python script to merge books downloaded from Cambridge Core into a single PDF file.
## Installation
```bash
uv tool install git+https://github.com/SinTan1729/cambridge-core-merge
```
## Usage
```bash
cambridge-core-merge [-h] -z ZIPFILE -n NAME [-c COVER]
```
Available options:
```bash
-h, --help show this help message and exit
-z, --zipfile ZIPFILE
The path of the zip file obtained from Cambridge Core.
-n, --name NAME The path of the final PDF file.
-c, --cover COVER The path of the cover file. (Must be JPG.)
```