vark.github.com/index.html at master · vark/vark.github.com · GitHub

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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
    <title>Aardvark - A Sane Build Tool</title>
    <style TYPE="text/css">
       <!--
       body { font-family: Helvetica,sans-serif;
              background: white;
              color: #888888;
              margin: 16px 16px 16px 16px;
              }
       .header {
         width: 100%;
         border-bottom: 1px solid;
       }
       .title {
         font-size: 32pt;
       }
       .tagline {
         font-size: 12pt;
         font-style: italic;
         padding: 16px;
       }
       .links {
         height: 100%;
         padding: 0 16px 0 0;
         font-size: 14pt;
         float: left;
         border-right: 1px solid;
       }
       .sectionTitle {
         font-size: 20pt;
       }
       .content {
         padding-left: 240px;
         color: black;
         font-size: 12pt;
       }
       .varkfile {
         white-space: pre;
         font-family: Courier,monospace;
         font-size: 10pt;
         margin: 0;
         padding: 8px;
         border: 1px solid #bbbbbb;
         background-color: #eeeeee;
       }
       a:link { color: #ff0000; }
       a:visited { color: #ff8080; }
       a:active { color: #a05050; }
        -->
     </style>
  </head>
  <body>
    <div class="header"><span class="title">Aardvark</span><span class="tagline">A Sane Build Tool</span></div>
    <div>
      <div class="links">
        <ul>
          <li>Downloads:</li>
          <ul>
            <li><a href="https://github.com/downloads/vark/Aardvark/aardvark-0.4-bin.zip">aardvark.zip</a></li>
            <li><a href="https://github.com/downloads/vark/Aardvark/aardvark-0.4-bin.tar.gz">aardvark.tgz</a></li>
            <li><a href="https://github.com/vark/Aardvark/downloads"><i>more</i></a></li>
          </ul>
          <li><a href="http://github.com/vark/Aardvark">Source</a></li>
          <li><a href="http://github.com/vark/Aardvark/wiki">Documentation</a></li>
          <li><a href="http://github.com/vark/Aardvark/wiki/why">Why</a></li>
          <li><a href="http://github.com/vark/Aardvark/issues">Issues</a></li>
          <li><a href="http://groups.google.com/group/aardvarkgw">Discuss</a></li>
          <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html">License</a></li>
        </ul>
      </div>
      <div class="content">
        <p>Aardvark is a tool for building projects.  It is based on <a href="http://gosu-lang.org">Gosu</a>
        and <a href="http://ant.apache.org/">Apache Ant</a>.  It is intended to provide a comfortable scripting
        environment while retaining all the functionality that Ant tasks provide.</p>

        <p>It has a lot of cool features which we will be documenting in the next few weeks.  If you'd like to keep up with this, please join our <a href="http://groups.google.com/group/aardvarkgw">Google group</a>.</p>

        <span class="sectionTitle">build.vark</span>
        <p>Here is an example build.vark file, which is structured just like a Gosu program, with some special sauce:</p>
        <div class="varkfile">var srcDir = file("src")
var classesDir = file("classes")
var distDir = file("dist")

function echoHello() {
  Ant.echo(:message = "Hello World")
}

function compile() {
  Ant.mkdir(:dir = classesDir)
  Ant.javac(:srcdir = path(srcDir),
            :destdir = classesDir,
            :includeantruntime = false)
}

@Depends("compile")
function jar() {
  Ant.mkdir(:dir = distDir)
  Ant.jar(:destfile = distDir.file("myproject.jar"),
          :basedir = classesDir)
}

@Depends("compile")
function run() {
  Ant.java(:classname = "myproject.HelloWorld",
           :classpath = path(classesDir),
           :fork = true)
}

function clean() {
  Ant.delete(:dir = classesDir)
  Ant.delete(:dir = distDir)
}</div>
        <p>Note, in particular, the 'Ant' symbol, which exposes the entire Ant API as functions.</p>

        <span class="sectionTitle">Running Aardvark</span>
        <p>To use Aardvark, download and unzip a distribution, and put its bin/ directory on your path.</p>
        <p>You run it exactly the same as how you run Ant. Within the directory which contains build.vark, simply run the "vark" executable followed by the desired target name:</p>
        <div class="varkfile">$ vark jar
Buildfile: myproject/build.vark

compile:
    [mkdir] Created dir: myproject/classes
    [javac] Compiling 1 source file to myproject/classes

jar:
    [mkdir] Created dir: myproject/dist
      [jar] Building jar: myproject/dist/myproject.jar

BUILD SUCCESSFUL
Total time: 0 seconds</div>
        <p>If you'd like to use a .vark file that is in another directory and/or named other than build.vark, it is again just like Ant:</p>
        <div class="varkfile">$ vark -f <i>other.vark</i>
$ vark -f <i>path/to/build.vark</i>
$ vark -f <i>path/to/other.vark</i></div>
        <p></p>

        <span class="sectionTitle">VEdit</span>
        <p>Aardvark ships with a built in graphical editor for vark files, 'vedit'.  You can edit a vark file by using the "vedit" executable in place of "vark"</p>
        <div class="varkfile">$ vedit
$ vedit -f <i>other.vark</i>
$ vedit -f <i>path/to/build.vark</i>
$ vedit -f <i>path/to/other.vark</i></div>
      </div>
    </div>
	<script type="text/javascript">

	  var _gaq = _gaq || [];
	  _gaq.push(['_setAccount', 'UA-19879697-1']);
	  _gaq.push(['_trackPageview']);

	  (function() {
	    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	  })();

	</script>
  </body>
</html>