Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Improves README for better display on Github #29

Closed
wants to merge 2 commits into from

2 participants

Commits on Jan 25, 2012
  1. @videlalvaro
  2. @videlalvaro
This page is out of date. Refresh to see the latest.
Showing with 26 additions and 33 deletions.
  1. +26 −33 README → README.md
View
59 README → README.md
@@ -1,8 +1,7 @@
- OPA
+# OPA #
-Overview
---------
+## Overview ##
Opa is a new generation of cloud development platform. It is a new programming
language, a new web server, a new database and a new distributed execution
@@ -12,29 +11,26 @@ developers.
This repository contains all the sources of the OPA compiler and libraries.
-Quick build instructions
-------------------------
+## Quick build instructions ##
-$ ./configure
-$ make
-$ sudo make install
+ $ ./configure
+ $ make
+ $ sudo make install
-should get you there. ./configure should report any missing dependencies and
+should get you there `./configure` should report any missing dependencies and
point you to the packages you may install to fix them (although those may depend
on your distribution). make needs to be GNU make.
The main dependency of OPA is OCaml 3.12. 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
+use the `installation_helper.sh` script, which automates the download and
installation of our dependencies. Try
-$ dependencies/installation_helper.sh --help
+ $ dependencies/installation_helper.sh --help
+## Directory layout ##
-Directory layout
-----------------
-
-* _build: compilation target directory
+* \_build: compilation target directory
* build: build scripts and auxiliary Makefiles
* copyright: some copyright information used in our binary package, which
includes external software (as obtained from the dependency installation
@@ -52,31 +48,29 @@ The other directories contain the source of the OPA libraries, compiler, and
tools.
Files at the root of the repository:
-* *.mllib: ocamlbuild target declaration for building an ocaml lib
-* *.itarget: ocamlbuild target declaration for building a set of targets
-* install_release.sh: builds a full OPA runtime in order to make a binary
+
+* `*.mllib`: ocamlbuild target declaration for building an ocaml lib
+* `*.itarget`: ocamlbuild target declaration for building a set of targets
+* `install_release.sh`: builds a full OPA runtime in order to make a binary
package
-* platform_helper.sh: some helpers to guarantee script compatibility, mostly
+* `platform_helper.sh`: some helpers to guarantee script compatibility, mostly
between Linux and MacOS
-* make_package.sh: builds various kinds of binary packages from the file
- hierarchy created by install_release.sh
+* `make_package.sh`: builds various kinds of binary packages from the file
+ hierarchy created by `install_release.sh`
-The build system
-----------------
+## The build system ##
-The build system is based on OCamlbuild; the included build/Makefile.bld
+The build system is based on OCamlbuild; the included `build/Makefile.bld`
dynamically builds an ocamlbuild plugin and generates targets based on files
-build_libs, build_tools and build_rules.ml.
-
-See build/Makefile.bld and build_rules.ml for more information. All generated
-files are put in _build, following the same hierarchy as the source directory.
+`build_libs`, `build_tools` and `build_rules.ml`.
+See `build/Makefile.bld` and `build_rules.ml` for more information. All generated
+files are put in `_build`, following the same hierarchy as the source directory.
-License & Credits
------------------
+## License & Credits ##
-OPA is Copyright 2011, MLstate ; it is distributed under the terms of the GNU
+OPA is Copyright 2011, MLstate; it is distributed under the terms of the GNU
Affero General Public License, version 3. See file LICENSE for details.
The repository opalang is currently versioning 2 external tools in tools/
@@ -104,8 +98,7 @@ Contact
-------
All bug reports, feedback, comments, contributions or remarks are welcome,
-either on our website:
- http://opalang.org
+either on our website: [http://opalang.org](http://opalang.org)
or by email, to:
support@opalang.org
Something went wrong with that request. Please try again.