About

code2pdf is a simple tool for convert your source code to a PDF file.

It can be useful if you need to licence you software.

Installation

gem install code2pdf

Usage

Open a terminal and run:

code2pdf <project path> <blacklist file>

BlackList file example:

The blacklist file must be a yaml file, as such:

:directories:
  - .git
  - db/migrate
  - doc
  - log
  - public/images
  - public/system
  - script
  - spec
  - test
  - tmp
  - vendor
:files:
  - .DS_Store
  - .eprj
  - .gitignore
  - .rspec
  - .rvmrc
  - database.yml
  - development.sqlite3
  - application.yml
  - favicon.ico
  - controls.js
  - dragdrop.js
  - effects.js
  - prototype.js
  - rails.js

PDF output example

example.pdf

Contributing to Lucas Caton

Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
Fork the project
Start a feature/bugfix branch
Commit and push until you are happy with your contribution
Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

willian/code2pdf

About

Installation

Usage

BlackList file example:

PDF output example

Contributing to Lucas Caton

Copyright