summaryrefslogtreecommitdiffstats
path: root/README.rdoc
blob: 05bd9f188978668b3f7313d22a5ec6bc9c005d2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
ffi-e17
    by Jérémy Zurcher
    http://cgit.asynk.ch

== DESCRIPTION:

ffi-e17 is a FFI[https://github.com/ffi/ffi/wiki] binding to Enlightenment Foundation Libraries (eina,eet,evas,ecore,edje)
and Elementary, part of the Enlightenment project. (E17 API[http://www.enlightenment.org/p.php?p=docs&l=en])

== FEATURES/PROBLEMS:

* Project just started

== SYNOPSIS:

    require './lib/e17'
    include E17
    EET.init
    EET.open('/tmp/_eet.cfg', EET::FILE_MODE_WRITE) do |f|
        f.write 'config2', 'test--key'
    end
    EET.open('/tmp/_eet.cfg', EET::FILE_MODE_READ) do |f|
        puts f.read('config2')
    end
    EET.shutdown

For less minimalistic and more sane examples you may look at:

* the spec/ folder

== REQUIREMENTS:

* You need a sane enlightenment foundation libraries installation,
  for this you might like to use easy_e17.sh[http://omicron.homeip.net/projects/#easy_e17.sh].

== DOWNLOAD/INSTALL:

From rubyforge:

  [sudo] gem install ffi-e17

or from the git repository on github:

  git clone git://github.com/jeremyz/ffi-e17.git
  cd ffi-e17
  rake gem:install

== CREDITS:

Special thanks to:

* need help ...

== LICENSE:

See MIT-LICENSE file.