Module: Flammarion

Defined in:
lib/flammarion.rb,
lib/flammarion/pane.rb,
lib/flammarion/plot.rb,
lib/flammarion/about.rb,
lib/flammarion/server.rb,
lib/flammarion/version.rb,
lib/flammarion/engraving.rb,
lib/flammarion/revelator.rb,
lib/flammarion/writeable.rb

Overview

This is the main namespace for Flammarion. You really need an Engraving to do anything useful. If you just want to test that everything is setup correctly, you can use Flammarion.about. You can find samples and screenshots at github.com/zach-capalbo/flammarion and some examples at github.com/zach-capalbo/flammarion/tree/master/examples

Defined Under Namespace

Modules: Revelator, Writeable Classes: Engraving, Pane, Plot, Server, SetupError

Constant Summary collapse

VERSION =
"0.3.0"

Class Method Summary collapse

Class Method Details

.aboutObject

Pops up a little about box.


3
4
5
6
7
8
9
10
11
12
# File 'lib/flammarion/about.rb', line 3

def self.about
  f = Engraving.new(close_on_exit:true)
  f.title "Flammarion #{VERSION}"
  readme = "#{File.absolute_path(File.dirname(__FILE__))}/../../Readme.md"
  license = "#{File.absolute_path(File.dirname(__FILE__))}/../../LICENSE"
  f.markdown(File.read(readme))
  f.break
  f.markdown(File.read(license))
  f.wait_until_closed
end