Indoctrinator is a RubyMotion gem that provides a Path style tutorial view for iOS applications.
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
lib
resources
spec
vendor
.gitignore
Gemfile
Gemfile.lock
README.md
Rakefile
indoctrinator.gemspec

README.md

Indoctrinator

Indoctrinator is a RubyMotion gem that provides a Path style tutorial view for iOS applications. Utilizing the ICETutorial pod, indoctrinator makes it easy to add a tutorial slideshow to your app.

Installation

Bundler

Add this line to your application's Gemfile:

gem "indoctrinator"

And then execute:

$ bundle

Usage

# A simple tutorial consisting of three pages
tut1 = Indoctrinator::Page.new(image: "tutorial1")
tut2 = Indoctrinator::Page.new(image: "tutorial2")
tut3 = Indoctrinator::Page.new(image: "tutorial3")
Indoctrinator::Tutorial.new([tut1, tut2, tut3])

# Tutorials may also have a title
Indoctrinator::Tutorial.new([tut1, tut2, tut3], title: "My Tutorial")

# More to come...

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request