Skip to content
This repository
Newer
Older
100644 96 lines (66 sloc) 3.905 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
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
3 ## Overview ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
4
a47b5ec8 » Henri Binsztok
2012-06-28 [doc] README: updated for 1.0
5 Opa is an advanced framework for JavaScript, made of two parts:
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
6
a47b5ec8 » Henri Binsztok
2012-06-28 [doc] README: updated for 1.0
7 * A compiler from the Opa language, which features JavaScript-like syntax but introduces many enhancements;
8 * A JavaScript library, which is used at runtime.
fccc6851 » MLstate
2011-06-21 Initial open-source release
9
a47b5ec8 » Henri Binsztok
2012-06-28 [doc] README: updated for 1.0
10 This repository contains all the sources of both the Opa compiler and the Opa library.
fccc6851 » MLstate
2011-06-21 Initial open-source release
11
bd15dfa1 » cedricss
2012-08-17 [doc] Readme: link to the dedicated Getting Started guide added
12 ## Getting Started ##
13
8705cd2c » opalang
2012-10-03 [doc] README: updated the "dedicated guide" link
14 Check out the [dedicated guide](https://github.com/MLstate/opalang/wiki/Getting-started).
bd15dfa1 » cedricss
2012-08-17 [doc] Readme: link to the dedicated Getting Started guide added
15
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
16 ## Quick build instructions ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
17
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
18 $ ./configure
19 $ make
20 $ sudo make install
fccc6851 » MLstate
2011-06-21 Initial open-source release
21
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
22 should get you there. `./configure` should report any missing dependencies and
fccc6851 » MLstate
2011-06-21 Initial open-source release
23 point you to the packages you may install to fix them (although those may depend
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
24 on your distribution). `make` needs to be GNU make.
fccc6851 » MLstate
2011-06-21 Initial open-source release
25
7c09637e » Aqua-Ye
2012-09-04 [doc] README: update
26 The main dependencies of Opa is OCaml 3.12 and Node.js >= 0.6. In case your distribution doesn't provide a recent enough version, or if you miss some other dependencies, you can 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
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
29 $ tools/dependencies/installation_helper.sh --help
fccc6851 » MLstate
2011-06-21 Initial open-source release
30
6f743ab2 » cedricss
2012-08-24 [doc] Readme: amazon image link added
31 #### Amazon Image
32
33 We provide a ready to use [Amazon Image for Opa](https://github.com/MLstate/opalang/wiki/Amazon-Image-for-Opa).
34
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
35 ## Directory layout ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
36
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
37 * \_build: compilation target directory
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
38 * compiler: compiler source files
39 * doc: documentation source files, guidelines, and miscellaneous copyright information
40 * lib: Opa standard library, plugins and binding system library source files
41 * ocamllib: OCaml libraries and runtime source files
42 * tools: various tools
43
44 Details of the lib directory:
45
46 * stdlib: the Opa standard library
47 * plugins: additional Opa library modules
48 * opabsl: the Opa binding system library, for binding various backends (currently node and OCaml)
49 * experimental: some experimental Opa libraries
50
51 Details of the doc directory:
52
fccc6851 » MLstate
2011-06-21 Initial open-source release
53 * copyright: some copyright information used in our binary package, which
54 includes external software (as obtained from the dependency installation
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
55 helper)
56 * `*-LICENSE`: licenses used by the Opa project
57
58 Details of the tools directory:
59
60 * build: build scripts and auxiliary Makefiles
61 * dependencies: contains the dependency installation helper and various patches
fccc6851 » MLstate
2011-06-21 Initial open-source release
62 * dissemination: contains helper programs to run on the cloud (transitional)
63 * installer: auxiliary files used to build binary packages
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
64 * tools: contains external checking tools
65 * bash: bash completion scripts
66 * editors: various helper tools for popular editors
67 * utils: packaging scripts, and various auxiliary tools
fccc6851 » MLstate
2011-06-21 Initial open-source release
68
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
69 Other files usage:
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
70
71 * `*.mllib`: ocamlbuild target declaration for building an ocaml lib
72 * `*.itarget`: ocamlbuild target declaration for building a set of targets
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
73 * `tools/platform_helper.sh`: some helpers to guarantee script compatibility, mostly
fccc6851 » MLstate
2011-06-21 Initial open-source release
74 between Linux and MacOS
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
75 * `tools/utils/install_release.sh`: builds a full Opa runtime in order to make a binary package
76 * `tools/utils/make_package.sh`: builds various kinds of binary packages from the file
77 hierarchy created by `tools/utils/install_release.sh`
fccc6851 » MLstate
2011-06-21 Initial open-source release
78
1c2e3e01 » videlalvaro
2012-01-25 [doc] README: Converted README to Markdown
79 ## The build system ##
fccc6851 » MLstate
2011-06-21 Initial open-source release
80
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
81 The build system is based on OCamlbuild; the included `tools/build/Makefile.bld`
fccc6851 » MLstate
2011-06-21 Initial open-source release
82 dynamically builds an ocamlbuild plugin and generates targets based on files
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
83 `tools/build/build_libs`, `tools/build/build_tools` and `tools/build/build_rules.ml`.
fccc6851 » MLstate
2011-06-21 Initial open-source release
84
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
85 See `tools/build/Makefile.bld` and `tools/build/build_rules.ml` for more information. All generated files are put in `_build`, following the same hierarchy as the source directory.
fccc6851 » MLstate
2011-06-21 Initial open-source release
86
2cac7a39 » Aqua-Ye
2012-07-13 [doc] README, Makefile: small update
87 You can find more information about the build system in tools/build/README.
88
fccc6851 » MLstate
2011-06-21 Initial open-source release
89 Contact
90 -------
91
148033dd » Aqua-Ye
2012-07-10 [doc] README: updated README for the new repo structure
92 All bug reports, feedback, comments, contributions or remarks are welcome: [http://opalang.org](http://opalang.org).
fccc6851 » MLstate
2011-06-21 Initial open-source release
93
a47b5ec8 » Henri Binsztok
2012-06-28 [doc] README: updated for 1.0
94 In particular, users are welcome to:
be978930 » Aqua-Ye
2012-09-26 [doc] README: markdown typo
95 * subscribe on the mailing list at [OWASP](https://lists.owasp.org/listinfo/opa);
96 * participate in the forum at [opalang](http://forum.opalang.org).
Something went wrong with that request. Please try again.