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