Skip to content

Commit

Permalink
Documentation updates regarding using the precompiled Ruby converter
Browse files Browse the repository at this point in the history
  • Loading branch information
obilodeau committed Sep 20, 2017
1 parent 585bc60 commit 4ee53dd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
21 changes: 21 additions & 0 deletions HACKING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ done with `bundler`:

bundle config --local github.https true
bundle --path=.bundle/gems --binstubs=.bundle/.bin
bundle exec rake build

Go to `test/output/slim/` folder and install `reveal.js`:

Expand Down Expand Up @@ -214,6 +215,25 @@ NOTE: The relative portion of the last command is where you are installing the l

Then proceed as documented in the `README.adoc`.


== RubyGem package

=== Test a local asciidoctor-revealjs version

Compile the converter:

$ bundle exec rake build

In a clean directory besides the `asciidoctor-reveal.js` repository, create the following `Gemspec` file:

source 'https://rubygems.org'
gem 'asciidoctor-revealjs', :path => '../asciidoctor-reveal.js'

Then run:

$ bundle --path=.bundle/gems --binstubs=.bundle/.bin


== Release process

. Update the version in `lib/asciidoctor-revealjs/version.rb` and `package.json`
Expand All @@ -231,6 +251,7 @@ Then proceed as documented in the `README.adoc`.
. Make a release on github (from changelog and copy from previous releases)
. Pushing the gem on rubygems.org:
+
$ bundle exec rake build
$ gem build asciidoctor-revealjs.gemspec
$ gem push asciidoctor-revealjs-X.Y.Z.gem

Expand Down
1 change: 0 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ NOTE: These instructions should be repeated for every presentation project.
source 'https://rubygems.org'
gem 'asciidoctor-revealjs' # latest released version
#gem 'asciidoctor-revealjs', github: 'asciidoctor/asciidoctor-reveal.js' # github master branch
----
+
NOTE: For some reason, when you use the system Ruby on Fedora, you also have to add the json gem to the Gemfile.
Expand Down

0 comments on commit 4ee53dd

Please sign in to comment.