Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 65 lines (42 sloc) 1.757 kb
c2d5280 @ericbmerritt split getting the deps from the actual build
authored
1 Installing Joxa
2 ===============
3
4 The easiest way by far to install joxa is to simply
5 [download it from the github site](https://github.com/erlware/joxa/downloads). This
6 will give you an executable file that will serve as your shell and
7 compiler (see the manual). However, if you would like to build from
8 the repository there are a few things you should do.
9
10 TLDR
11 ----
12
13 $> make get-deps
14 $> make test
15 $> make escript
16 $> mv ./_build/joxa/escript/joxa <someplace-in-the-path>
17
18 Get The Dependencies
19 --------------------
20
21 Joxa has several compile time dependencies and one two time dependencies.
22
23 ### Compile Time Dependencies
24
25 * [Proper](https://github.com/manopapad/proper) at least version 1.0
26
27 ### Runtime Dependencies
28
29 * [Getopt](https://github.com/jcomellas/getopt) at least version 0.4.2
30 * [Erlware Commons](https://github.com/erlware/erlware_commons) at
31 least version 0.6.1
32
33 You can pull all of these down build them and put them somewhere in
34 your erlang path (ERL_LIBS). However, there is a rule in the make file
35 that will do this as well. Just run
36
37 $> make get-deps
38
39 Running The Tests
40 -----------------
41
42 Make sure you run the tests, otherwise how will you know if it works?
43
44 $> make test
45
46 Executable File (escript)
47 -------------------------
48
49 Finally build the escript. This will give you a binary executable that
50 you can use to run joxa.
51
52 $> make escript
53
54 Then you can just mv the executable to some place in your path.
55
56 $> mv ./_build/joxa/escript/joxa <someplace-in-the-path>
57
58
59 OTP Application
60 ---------------
61
62 If you would like to have access to the OTP application to use as a
63 dependency you might want to move the built application to someplace
64 in your ERL_LIBS path. This is located in _build/joxa/lib/joxa-<vsn>
Something went wrong with that request. Please try again.