Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucascaton/code2pdf

Convert your source code to PDF
https://github.com/lucascaton/code2pdf

Last synced: 6 days ago
JSON representation

Convert your source code to PDF

Host: GitHub
URL: https://github.com/lucascaton/code2pdf
Owner: lucascaton
License: other
Created: 2011-06-02T18:30:38.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2023-11-05T04:01:43.000Z (about 1 year ago)
Last Synced: 2024-12-14T22:05:10.726Z (13 days ago)
Language: Ruby
Homepage: https://www.lucascaton.com.br/
Size: 354 KB
Stars: 119
Watchers: 2
Forks: 46
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# code2pdf

[![Gem Version](https://badge.fury.io/rb/code2pdf.svg)](https://rubygems.org/gems/code2pdf)

**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

## BlackList file example:

The blacklist file must be a yaml file named `.code2pdf`, placed in project root path, containing a list of ignored files and/or directories, such as:

```yaml
:directories:
- .git
- log
- public/system
- tmp
- vendor
:files:
- .DS_Store
- database.yml
- favicon.ico
```

## PDF output example

[example.pdf](https://github.com/lucascaton/code2pdf/raw/master/examples/example.pdf)

## Contributing

* 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.