-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
20ba8e8
commit ddca2a1
Showing
1 changed file
with
14 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,120 +1,23 @@ | ||
| gamma-view | ||
| ========== | ||
|
|
||
| We use this library on GitHub when rendering your README or any other | ||
| rich text file. | ||
|
|
||
| Markups | ||
| ------- | ||
|
|
||
| The following markups are supported. The dependencies listed are required if | ||
| you wish to run the library. | ||
|
|
||
| * [.markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` (https://github.com/tanoku/redcarpet) | ||
| * [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth` | ||
| * [.rdoc](http://rdoc.sourceforge.net/) -- `gem install rdoc -v 3.6.1` | ||
| * [.org](http://orgmode.org/) -- `gem install org-ruby` | ||
| * [.creole](http://wikicreole.org/) -- `gem install creole` | ||
| * [.mediawiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth` | ||
| * [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils` | ||
| * [.asciidoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc` | ||
| * [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` | ||
| comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. | ||
|
|
||
|
|
||
| Contributing | ||
| ------------ | ||
|
|
||
| Want to contribute? Great! There are two ways to add markups. | ||
|
|
||
|
|
||
| ### Commands | ||
|
|
||
| If your markup is in a language other than Ruby, drop a translator | ||
| script in `lib/github/commands` which accepts input on STDIN and | ||
| returns HTML on STDOUT. See [rest2html][r2h] for an example. | ||
|
|
||
| Once your script is in place, edit `lib/github/markups.rb` and tell | ||
| GitHub Markup about it. Again we look to [rest2html][r2hc] for | ||
| guidance: | ||
|
|
||
| command(:rest2html, /re?st(.txt)?/) | ||
|
|
||
| Here we're telling GitHub Markup of the existence of a `rest2html` | ||
| command which should be used for any file ending in `rest`, | ||
| `rst`, `rest.txt` or `rst.txt`. Any regular expression will do. | ||
|
|
||
| Finally add your tests. Create a `README.extension` in `test/markups` | ||
| along with a `README.extension.html`. As you may imagine, the | ||
| `README.extension` should be your known input and the | ||
| `README.extension.html` should be the desired output. | ||
|
|
||
| Now run the tests: `rake` | ||
|
|
||
| If nothing complains, congratulations! | ||
|
|
||
|
|
||
| ### Classes | ||
|
|
||
| If your markup can be translated using a Ruby library, that's | ||
| great. Check out Check `lib/github/markups.rb` for some | ||
| examples. Let's look at Markdown: | ||
|
|
||
| markup(:markdown, /md|mkdn?|markdown/) do |content| | ||
| Markdown.new(content).to_html | ||
| end | ||
|
|
||
| We give the `markup` method three bits of information: the name of the | ||
| file to `require`, a regular expression for extensions to match, and a | ||
| block to run with unformatted markup which should return HTML. | ||
|
|
||
| If you need to monkeypatch a RubyGem or something, check out the | ||
| included RDoc example. | ||
|
|
||
| Tests should be added in the same manner as described under the | ||
| `Commands` section. | ||
|
|
||
|
|
||
| Installation | ||
| ----------- | ||
|
|
||
| gem install github-markup | ||
|
|
||
|
|
||
| Usage | ||
| ----- | ||
|
|
||
| require 'github/markup' | ||
| GitHub::Markup.render('README.markdown', "* One\n* Two") | ||
|
|
||
| Or, more realistically: | ||
|
|
||
| require 'github/markup' | ||
| GitHub::Markup.render(file, File.read(file)) | ||
|
|
||
|
|
||
| Testing | ||
| Program gamma-view receives data from GammaUSB interface (some Cypress USB microprocessor). | ||
| It can: | ||
| * receive data from USB interface; | ||
| * translate data from raw data to points, time markers, and triggers; | ||
| * filter data to make pictures uniform (in brightness and geometry); | ||
| * save data to a file; | ||
| * open data from a file, like a virtual GammaUSB; | ||
| * show pictures in OpenGL; | ||
|
|
||
| Develop | ||
| ------- | ||
|
|
||
| To run the tests: | ||
|
|
||
| $ rake | ||
|
|
||
| To add tests see the `Commands` section earlier in this | ||
| README. | ||
|
|
||
| Program is in early development stage. Not all functionalities works. | ||
|
|
||
| Contributing | ||
| ------------ | ||
| ### Compiling | ||
|
|
||
| 1. Fork it. | ||
| 2. Create a branch (`git checkout -b my_markup`) | ||
| 3. Commit your changes (`git commit -am "Added Snarkdown"`) | ||
| 4. Push to the branch (`git push origin my_markup`) | ||
| 5. Create an [Issue][1] with a link to your branch | ||
| 6. Enjoy a refreshing Diet Coke and wait | ||
| You have to install and compile toolsets into default locations from toolset folder. | ||
| You have to install Visual Studio C++ 2008 and compile project from it. | ||
|
|
||
|
|
||
| [r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html | ||
| [r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13 | ||
| [1]: http://github.com/github/markup/issues |