Skip to content
This repository
Newer
Older
100644 109 lines (75 sloc) 4.116 kb
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
1 # Opa #
fccc6851 » MLstate
2011-06-21 Initial open-source release
2
3
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
4 ## Overview ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
5
6 Opa is a new generation of cloud development platform. It is a new programming
7 language, a new web server, a new database and a new distributed execution
8 engine, all of them tightly integrated to provide a great experience for cloud
9 developers.
10
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
11 This repository contains all the sources of the Opa compiler and libraries.
fccc6851 » MLstate
2011-06-21 Initial open-source release
12
13
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
14 ## Quick build instructions ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
15
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
16 $ ./configure
17 $ make
18 $ sudo make install
fccc6851 » MLstate
2011-06-21 Initial open-source release
19
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
20 should get you there `./configure` should report any missing dependencies and
fccc6851 » MLstate
2011-06-21 Initial open-source release
21 point you to the packages you may install to fix them (although those may depend
1321ba91 » Frédéric Perrin
2011-09-21 On FreeBSD check and use gmake, use make elsewhere
22 on your distribution). make needs to be GNU make.
fccc6851 » MLstate
2011-06-21 Initial open-source release
23
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
24 The main dependency of Opa is OCaml 3.12. In case your distribution doesn't
fccc6851 » MLstate
2011-06-21 Initial open-source release
25 provide a recent enough version, or if you miss some other dependencies, you can
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
26 use the `installation_helper.sh` script, which automates the download and
fccc6851 » MLstate
2011-06-21 Initial open-source release
27 installation of our dependencies. Try
28
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
29 $ dependencies/installation_helper.sh --help
fccc6851 » MLstate
2011-06-21 Initial open-source release
30
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
31 ## Directory layout ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
32
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
33 * \_build: compilation target directory
fccc6851 » MLstate
2011-06-21 Initial open-source release
34 * build: build scripts and auxiliary Makefiles
35 * copyright: some copyright information used in our binary package, which
36 includes external software (as obtained from the dependency installation
37 helper).
38 * dependencies: contains the dependency installation helper
39 * dissemination: contains helper programs to run on the cloud (transitional)
40 * installer: auxiliary files used to build binary packages
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
41 * plugins: additional Opa library modules (work in progress)
42 * stdlib: the Opa standard library
fccc6851 » MLstate
2011-06-21 Initial open-source release
43 * tools: contains external checking tools; see Credits below
44 * utils: some auxiliary, independent tools like bash completion, syntax
45 highlighting for popular editors, etc.
46
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
47 The other directories contain the source of the Opa libraries, compiler, and
fccc6851 » MLstate
2011-06-21 Initial open-source release
48 tools.
49
50 Files at the root of the repository:
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
51
52 * `*.mllib`: ocamlbuild target declaration for building an ocaml lib
53 * `*.itarget`: ocamlbuild target declaration for building a set of targets
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
54 * `install_release.sh`: builds a full Opa runtime in order to make a binary
fccc6851 » MLstate
2011-06-21 Initial open-source release
55 package
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
56 * `platform_helper.sh`: some helpers to guarantee script compatibility, mostly
fccc6851 » MLstate
2011-06-21 Initial open-source release
57 between Linux and MacOS
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
58 * `make_package.sh`: builds various kinds of binary packages from the file
59 hierarchy created by `install_release.sh`
fccc6851 » MLstate
2011-06-21 Initial open-source release
60
61
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
62 ## The build system ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
63
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
64 The build system is based on OCamlbuild; the included `build/Makefile.bld`
fccc6851 » MLstate
2011-06-21 Initial open-source release
65 dynamically builds an ocamlbuild plugin and generates targets based on files
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
66 `build_libs`, `build_tools` and `build_rules.ml`.
fccc6851 » MLstate
2011-06-21 Initial open-source release
67
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
68 See `build/Makefile.bld` and `build_rules.ml` for more information. All generated
69 files are put in `_build`, following the same hierarchy as the source directory.
fccc6851 » MLstate
2011-06-21 Initial open-source release
70
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
71 ## License & Credits ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
72
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
73 Opa is Copyright 2011, MLstate; it is distributed under the terms of the GNU
fccc6851 » MLstate
2011-06-21 Initial open-source release
74 Affero General Public License, version 3. See file LICENSE for details.
75
76 The repository opalang is currently versioning 2 external tools in tools/
77 used only during the build process of Opa :
78
79 * The Closure Compiler (see tools/jschecker/README for copyright information)
80 * JsDoc Toolkit (see tools/jsdoc-toolkit/README.txt for copyright information)
81
82 The Closure Compiler is used as a checker for the Javascript part of the sources
83 of Opa, and JsDoc Toolkit is used for generating html documentation pages from this
84 Javascript code.
85
86 The use of these tools is transitional, and will soon be made optional.
87
59df0ea6 » mbarbin
2011-06-22 [release] add credits about jslib
88 Part of the jslang library, has been closely inspired by ocamljs/jslib:
89
90 * ocamljs/jslib, © 2007-2009 2007-9 Skydeck, Inc, distributed under LGPL v2
91
92 Files jslang/jsAst.ml and jslang/jsPrint.ml are extended versions of the modules
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
93 found in ocamljs, specialized for Opa specific needs.
59df0ea6 » mbarbin
2011-06-22 [release] add credits about jslib
94 We would like to thank the authors of the ocamljs/jslib.
95
e66e404d » Aqua-Ye
2012-03-13 [doc] readme,changelog: added credits to bootstrat and font awesome
96 Opa also includes external libraries :
97
98 * Bootstrap, from Twitter - http://twitter.github.com/bootstrap
99
100 * Font Awesome - http://fortawesome.github.com/Font-Awesome
fccc6851 » MLstate
2011-06-21 Initial open-source release
101
102 Contact
103 -------
104
105 All bug reports, feedback, comments, contributions or remarks are welcome,
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
106 either on our website: [http://opalang.org](http://opalang.org)
fccc6851 » MLstate
2011-06-21 Initial open-source release
107
108 or by email, to:
109 support@opalang.org
Something went wrong with that request. Please try again.