Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rillki authored Sep 24, 2021
1 parent adc4a71 commit 6fcb418
Showing 1 changed file with 49 additions and 16 deletions.
65 changes: 49 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,71 @@ Image to PDF conversion utility written in D programming language.

<img src="assets/screenshot.jpeg">

### Dependencies (DUB packages)
* [printed](https://github.com/AuburnSounds/printed)

### Usage
```
================================================================
img2pdf v1.1 -- Image to PDF converter.
----------------------------------------------------------------
=========================================================
img2pdf v1.3 -- Image to PDF converter.
---------------------------------------------------------
USAGE:
img2pdf [path] [imgs] [file] [stretch]
img2pdf [path] [images] [file] {options}
OPTIONS:
[stretch] stretch img to PDF page size
-strue, -sfalse
[order] sort files (ascending, descending)
-asc, -desc
DEFAULTS:
[path] cwd/ ('/' path identifier)
[imgs] all *.jpg, *.png in path
[file] path/output.pdf
[stretch] -strue (stretch img to PDF page size)
[path] cwd/ ('/' or '\\' path identifier)
[images] all *.jpg, *.png in [path]
[file] [path]/output.pdf
[stretch] -strue
[order] -asc
EXAMPLE:
img2pdf ../temp/ img1.png,img2.jpg myImages.pdf -sfalse
================================================================
img2pdf ../temp/ img1.png,img2.jpg myImages.pdf
-sfalse -asc
=========================================================
```

### Building
### Building and Installing
#### Required
* [D compiler](https://dlang.org/download)
* [D compiler](https://dlang.org/download) (DMD is recommended)
* [DUB](https://dub.pm) package manager

##### Note for Windows 10 users
When downloading DMD, choose `exe`. It is the official D `installer` that will install both `DMD` and `DUB` to your system.

#### Dependencies (managed by DUB automatically)
* [printed](https://github.com/AuburnSounds/printed)

#### Compiling
1. Clone the repository to your machine:
```
git clone https://github.com/rillki/img2pdf.git
```
2. Open your terminal or command line and `cd` to `img2pdf` folder:
```
cd img2pdf
```
3. Build the binary
```
dub --build=release
```
Your will find the binary in the `bin/` folder. Add it to your path. Enjoy!

Your will find the binary in the `bin/` folder. Add it to your `PATH` to use it freely.

### LICENSE
All code is licensed under [MIT](https://github.com/rillki/img2pdf/blob/main/LICENSE) license.












0 comments on commit 6fcb418

Please sign in to comment.