Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 106 lines (62 sloc) 3.134 kB
94462d9 Partial gemification of CodeRippa
Benjamin Tan Wei Hao authored
1 # CodeRippa
2
6138bfb added travis ci badge
Benjamin Tan Wei Hao authored
3 [![Build Status](https://secure.travis-ci.org/benjamintanweihao/code_rippa.png)](http://travis-ci.org/benjamintanweihao/code_rippa)
4
5599822 Updated README because my grammar is going downhill.
Benjamin Tan Wei Hao authored
5 _CodeRippa_ takes your source code and turns it into a beautiful PDF file. Currently, it supports 150 languages and 84 themes, all of which are available in TextMate.
94462d9 Partial gemification of CodeRippa
Benjamin Tan Wei Hao authored
6
51a68c0 Themes! Glorious themes
Benjamin Tan Wei Hao authored
7 ## Prerequisites
db39502 Long lines wrap nicely, using a method I stole from Gem::Command. Upd…
Benjamin Tan Wei Hao authored
8
9 You will definitely need a TeX distribution installed. To check, simply type `pdflatex`.
10 In case your system doesn't have `pdflatex`, you should install a [LaTeX](http://www.tug.org/texlive/) distribution.
11
94462d9 Partial gemification of CodeRippa
Benjamin Tan Wei Hao authored
12 ## Installation
13
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
14 $ gem install code_rippa
94462d9 Partial gemification of CodeRippa
Benjamin Tan Wei Hao authored
15
16 ## Usage
17
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
18 ### Command line options
19
20 Usage: code_rippa [options] file_or_directory
21 -l, --list-themes List all available themes
22 -t, --theme THEME Selected theme
23 -n, --list-syntax List all available syntax
24 -h, --help Display this screen
25
032f3a3 updated test cases to reflect removal of moc
Benjamin Tan Wei Hao authored
26 ### List all available themes (84 and counting!)
0a1dfe8 updated README
Benjamin Tan Wei Hao authored
27
7459e92 checks if pdflatex is installed or not. automatically runs pdflatex
Benjamin Tan Wei Hao authored
28 Many of the themes found in CodeRippa can be found [here](http://textmatetheme.com/)
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
29
30 $ code_rippa -l
31
32 active4d
33 all_hallows_eve
34 amy
032f3a3 updated test cases to reflect removal of moc
Benjamin Tan Wei Hao authored
35 made_of_code
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
36 twilight
37 zenburnesque
38 ... more themes omitted
0a1dfe8 updated README
Benjamin Tan Wei Hao authored
39
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
40 ### Producing PDF from a single file
41
42 Example:
0a1dfe8 updated README
Benjamin Tan Wei Hao authored
43
44 Without theme specified (defaults to: _made_of_code_):
45
46 $ code_rippa path_to_single_file.rb
47
48 With theme specified:
49
50 $ code_rippa -t zenburnesque path_to_single_file.rb
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
51
b3101a0 updated README
Benjamin Tan Wei Hao authored
52 Note that the output file is saved as _out.pdf_ in the current directory where _code_rippa_ was called from.
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
53
54 ### Producing PDF from a directory
55
56 Example:
57
0a1dfe8 updated README
Benjamin Tan Wei Hao authored
58 Without theme specified (defaults to: _made_of_code_):
59
60 $ code_rippa path_to_directory
61
62 With theme specified:
63
64 $ code_rippa -t rubyblue path_to_directory
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
65
b3101a0 updated README
Benjamin Tan Wei Hao authored
66 Note that the output file is saved as _out.pdf_ in the current directory where _code_rippa_ was called from.
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
67
68 ## Credits
69
5599822 Updated README because my grammar is going downhill.
Benjamin Tan Wei Hao authored
70 None of this would be possible without the awesome [ultraviolet](https://github.com/giom/ultraviolet) [spox-ultraviolet](https://github.com/spox/ultraviolet) and [language_sniffer](https://github.com/grosser/language_sniffer) gems. Props to [__lwheng__](https://github.com/lwheng) for providing most of the LaTeX help.
94462d9 Partial gemification of CodeRippa
Benjamin Tan Wei Hao authored
71
72 ## Contributing
73
33f2f8f updated readme file. Improved exit codes
Benjamin Tan Wei Hao authored
74 Currently this gem is in its infancy. Any bug reports and feature requests are very welcomed.
4364457 bumped up version number
Benjamin Tan Wei Hao authored
75
76 ## Changelog
77
2b5030c updated README
Benjamin Tan Wei Hao authored
78 ### 0.0.7
30bcac9 quickfix to avoid parsing files that take up a large amount of column…
Benjamin Tan Wei Hao authored
79
51a68c0 Themes! Glorious themes
Benjamin Tan Wei Hao authored
80 - Using [language_sniffer](https://github.com/grosser/language_sniffer) in place of Linguist for automated source code language detection
ee2730f Updated README because my grammar is going downhill.
Benjamin Tan Wei Hao authored
81 - Themes! Glorious themes! 84 themes to choose from! Props to [filmgirl](https://github.com/filmgirl/TextMate-Themes), and the rest of the wonderful TM users who submitted their themes.
5599822 Updated README because my grammar is going downhill.
Benjamin Tan Wei Hao authored
82 - Wrap lines of troublesome files such as minified javascript and parser generator outputs.
0a1dfe8 updated README
Benjamin Tan Wei Hao authored
83 - Sensible defaults, removed the need for specifying the syntax
7459e92 checks if pdflatex is installed or not. automatically runs pdflatex
Benjamin Tan Wei Hao authored
84 - Detects if pdflatex is installed, and automatically runs pdflatex if so
db4527b updated README
Benjamin Tan Wei Hao authored
85 - Proper cleanup after LaTeX successfully completes
30bcac9 quickfix to avoid parsing files that take up a large amount of column…
Benjamin Tan Wei Hao authored
86
136cf41 bumped up to 0.0.6
Benjamin Tan Wei Hao authored
87 ### 0.0.6
88
89 - Include MiniTest specs
4ddd580 updated changelog
Benjamin Tan Wei Hao authored
90
91 ### 0.0.5
92
93 - Better performance when parsing.
94 - Code documentation.
95
4364457 bumped up version number
Benjamin Tan Wei Hao authored
96 ### 0.0.4
97
98 - Removed dependency on Linguist.
99 - Tidier code.
100
101 ### 0.0.1 - 0.0.3
102
103 - Initial gem push
104 - Fixed many stupid bugs along the way
105
Something went wrong with that request. Please try again.