-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
44 lines (32 loc) · 1.32 KB
/
README
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
ROL is ' Ray-uh Light '
Ray of Light aims to fill in for rdoc for reia.
yeh.. so whatever, Madonna grows less hot by the day
and we have to compensate..
basically this is a simple project to acquaint myself
with reia, the up and coming badasser of them all
Install:
None. That is of course as long as you have erlang and reia
installed. No?? Bad Monkey!
sudo apt-get install erlang
git clone git://github.com/tarcieri/reia.git
cd reia; rake; sudo rake install
Example:
Let's say we want to document the stdlib tcpsocket class.
All we need to do is pull out rol and execute:
(notice that I have not yet done ANY user-defined paths
so watch yourself before you break yourself)
reia rol.re ../reia/lib/tcpsocket.re
Testing:
Eventually we'll want to get behave testing all of our stuff
and be able to run this against itself -- however I'm tired and
I'm drunk and I'm going to bed.
Todo:
* need to put some smarter matchers in for identifying proper
structures -- maybe transfer to leex/yecc for superior grammar
based source parsing?
* implement behave: http://github.com/pirj/behave/tree/master
* implement some sort of text/markup/css (haml?) handler... prob
go look at ryan for answers..
* cleanup css
* cleanup homebrew classes
* support directories for multiple source files at once