Skip to content
This repository

Improves README for better display on Github #29

Closed
wants to merge 2 commits into from

2 participants

Alvaro Videla Quentin Bourgerie
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.

Showing 1 changed file with 26 additions and 33 deletions. Show diff stats Hide diff stats

  1. 59  README → README.md
59  README → README.md
Source Rendered
... ...
@@ -1,8 +1,7 @@
1  
-                                      OPA
  1
+# OPA #
2 2
 
3 3
 
4  
-Overview
5  
---------
  4
+## Overview ##
6 5
 
7 6
 Opa is a new generation of cloud development platform. It is a new programming
8 7
 language, a new web server, a new database and a new distributed execution
@@ -12,29 +11,26 @@ developers.
12 11
 This repository contains all the sources of the OPA compiler and libraries.
13 12
 
14 13
 
15  
-Quick build instructions
16  
-------------------------
  14
+## Quick build instructions ##
17 15
 
18  
-$ ./configure
19  
-$ make
20  
-$ sudo make install
  16
+    $ ./configure
  17
+    $ make
  18
+    $ sudo make install
21 19
 
22  
-should get you there. ./configure should report any missing dependencies and
  20
+should get you there `./configure` should report any missing dependencies and
23 21
 point you to the packages you may install to fix them (although those may depend
24 22
 on your distribution). make needs to be GNU make.
25 23
 
26 24
 The main dependency of OPA is OCaml 3.12. In case your distribution doesn't
27 25
 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
  26
+use the `installation_helper.sh` script, which automates the download and
29 27
 installation of our dependencies. Try
30 28
 
31  
-$ dependencies/installation_helper.sh --help
  29
+    $ dependencies/installation_helper.sh --help
32 30
 
  31
+## Directory layout ##
33 32
 
34  
-Directory layout
35  
-----------------
36  
-
37  
-* _build: compilation target directory
  33
+* \_build: compilation target directory
38 34
 * build: build scripts and auxiliary Makefiles
39 35
 * copyright: some copyright information used in our binary package, which
40 36
   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
52 48
 tools.
53 49
 
54 50
 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
  51
+
  52
+* `*.mllib`: ocamlbuild target declaration for building an ocaml lib
  53
+* `*.itarget`: ocamlbuild target declaration for building a set of targets
  54
+* `install_release.sh`: builds a full OPA runtime in order to make a binary
58 55
   package
59  
-* platform_helper.sh: some helpers to guarantee script compatibility, mostly
  56
+* `platform_helper.sh`: some helpers to guarantee script compatibility, mostly
60 57
   between Linux and MacOS
61  
-* make_package.sh: builds various kinds of binary packages from the file
62  
-  hierarchy created by install_release.sh
  58
+* `make_package.sh`: builds various kinds of binary packages from the file
  59
+  hierarchy created by `install_release.sh`
63 60
 
64 61
 
65  
-The build system
66  
-----------------
  62
+## The build system ##
67 63
 
68  
-The build system is based on OCamlbuild; the included build/Makefile.bld
  64
+The build system is based on OCamlbuild; the included `build/Makefile.bld`
69 65
 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.
  66
+`build_libs`, `build_tools` and `build_rules.ml`.
74 67
 
  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.
75 70
 
76  
-License & Credits
77  
------------------
  71
+## License & Credits ##
78 72
 
79  
-OPA is Copyright 2011, MLstate ; it is distributed under the terms of the GNU
  73
+OPA is Copyright 2011, MLstate; it is distributed under the terms of the GNU
80 74
 Affero General Public License, version 3. See file LICENSE for details.
81 75
 
82 76
 The repository opalang is currently versioning 2 external tools in tools/
@@ -104,8 +98,7 @@ Contact
104 98
 -------
105 99
 
106 100
 All bug reports, feedback, comments, contributions or remarks are welcome,
107  
-either on our website:
108  
-                               http://opalang.org
  101
+either on our website: [http://opalang.org](http://opalang.org)
109 102
 
110 103
 or by email, to:
111 104
                               support@opalang.org
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.