README.md in pdfs2pdf-0.1.0 vs README.md in pdfs2pdf-0.1.1
- old
+ new
@@ -1,25 +1,24 @@
-## Pdfs2Pdf
+## pdfs2pdf
[](http://badge.fury.io/rb/pdfs2pdf)
[](https://gemnasium.com/agilecreativity/pdfs2pdf)
[](https://codeclimate.com/github/agilecreativity/pdfs2pdf)
-Combine multiple PDF files into one file with simple bookmarks support using [Ghostscript][].
+Combine multiple PDF files into a single pdf file with simple bookmarks support using [Ghostscript][].
-Note: start from version `0.1.0` this gem will be released using [Semantic Versioning][] convention.
-
### What it does?
-Says you have the follow pdf files (included inside the test fixtures)
+Says you have the follow pdf files
```
./test/fixtures/samples/demo1_xxx.rb.xhtml.pdf
./test/fixtures/samples/demo2_xxx.rb.xhtml.pdf
./test/fixtures/samples/sub_dir/demo3_xxx.rb.xhtml.pdf
./test/fixtures/samples/sub_dir/demo4_xxx.rb.xhtml.pdf
```
+
Which have the following content:
- File: `./test/fixtures/samples/demo1_xxx.rb.xhtml.pdf`
@@ -38,27 +37,21 @@
When you run the following command:
```
gem install pdfs2pdf
-git clone https://github.com/agilecreativity/pdfs2pdf.git
-cd pdfs2pdf
-rbenv local 2.1.1 # if you use rbenv as your ruby manager
-rbenv rehash
-pdfs2pdf merge --base-dir ./test/fixtures/samples
+# Note: must change to the root of the directory that we want to start from
+cd ./test/fixtures/samples
+pdfs2pdf --recursive
```
Will produce the result like the following
-- File: `final_output.pdf` (excepted screenshot)
+- File: `pdfs2pdf_output.pdf` (excepted screenshot)
-- File: `final_output.pdf` (actual pdf)
-
-
-
### Requirements
### Mandatory Requirement
[Ghostscript][]
@@ -67,55 +60,43 @@
installation from source.
- Alternatively, for Ubuntu you can try `sudo apt-get install ghostscript` and under OSX
you can use [Homebrew](https://github.com/Homebrew/homebrew).
-## Usage
+### Usage
```sh
gem install pdfs2pdf
```
-For list of usage type
-```sh
-pdfs2pdf help
-```
-Which should give the following options
+### Usage/Synopsis:
```
-Commands:
- pdfs2pdf help [COMMAND] # Describe available commands or one specific command
- pdfs2pdf merge # Combine multiple pdfs into one file with bookmarks
- pdfs2pdf usage # Display usage information
-```
-
-Help on `merge` command just type `pdfs2pdf help merge`.
-
-Which should produce the following guide.
-
-```
Usage:
- pdfs2pdf merge [OPTIONS]
+ pdfs2pdf
Options:
- -b, [--base-dir=BASE_DIR] # Base directory
- # Default: . (current directory)
-r, [--recursive], [--no-recursive] # Search for files recursively
- # Default: true
-v, [--version], [--no-version] # Display version information
Combine multiple pdfs into one file with bookmarks
```
To combine multiple pdfs just try something like
```
-pdfs2pdf merge --base-dir ./test/fixtures/samples
+cd ./test/fixtures/samples
+pdfs2pdf -r
```
+
This will merge all the pdf files from `test/fixtures/samples` and generate the
-`final_output.pdf` in the current directory.
+`pdfs2pdf_output.pdf`.
### Known Issues
+
+- The combined bookmarks sometime does not produce the correct links to page number.
+Currently I am not sure what the workaround is. I love to hear from you if
+know more about the 'pdfmarks' format and how it works with the bookmarks.
- The directory that contains the pdf files must only contain the
letters, numbers and/or underscore characters. Any other characters like
`-` (dash) may caused the 'pdfmarks' file to produce incorrect bookmarks.