1 |=====
2 | Branch `trunk` | Branch `4.08` | Branch `4.07` | Branch `4.06` | Branch `4.05`
3
4 | image:https://travis-ci.org/ocaml/ocaml.svg?branch=trunk["TravisCI Build Status (trunk branch)",
5 link="https://travis-ci.org/ocaml/ocaml"]
6 image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=trunk&svg=true["AppVeyor Build Status (trunk branch)",
7 link="https://ci.appveyor.com/project/avsm/ocaml"]
8 | image:https://travis-ci.org/ocaml/ocaml.svg?branch=4.08["TravisCI Build Status (4.08 branch)",
9 link="https://travis-ci.org/ocaml/ocaml"]
10 image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.08&svg=true["AppVeyor Build Status (4.08 branch)",
11 link="https://ci.appveyor.com/project/avsm/ocaml"]
12 | image:https://travis-ci.org/ocaml/ocaml.svg?branch=4.07["TravisCI Build Status (4.07 branch)",
13 link="https://travis-ci.org/ocaml/ocaml"]
14 image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.07&svg=true["AppVeyor Build Status (4.07 branch)",
15 link="https://ci.appveyor.com/project/avsm/ocaml"]
16 | image:https://travis-ci.org/ocaml/ocaml.svg?branch=4.06["TravisCI Build Status (4.06 branch)",
17 link="https://travis-ci.org/ocaml/ocaml"]
18 image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.06&svg=true["AppVeyor Build Status (4.06 branch)",
19 link="https://ci.appveyor.com/project/avsm/ocaml"]
20 | image:https://travis-ci.org/ocaml/ocaml.svg?branch=4.05["TravisCI Build Status (4.05 branch)",
21 link="https://travis-ci.org/ocaml/ocaml"]
22 image:https://ci.appveyor.com/api/projects/status/github/ocaml/ocaml?branch=4.05&svg=true["AppVeyor Build Status (4.05 branch)",
23 link="https://ci.appveyor.com/project/avsm/ocaml"]
24 |=====
25
26 = README =
27
28 == Overview
29
30 OCaml is an implementation of the ML language, based on the Caml Light
31 dialect extended with a complete class-based object system and a powerful
32 module system in the style of Standard ML.
33
34 OCaml comprises two compilers. One generates bytecode which is then
35 interpreted by a C program. This compiler runs quickly, generates compact
36 code with moderate memory requirements, and is portable to essentially any
37 32 or 64 bit Unix platform. Performance of generated programs is quite good
38 for a bytecoded implementation. This compiler can be used either as a
39 standalone, batch-oriented compiler that produces standalone programs, or as
40 an interactive, toplevel-based system.
41
42 The other compiler generates high-performance native code for a number of
43 processors. Compilation takes longer and generates bigger code, but the
44 generated programs deliver excellent performance, while retaining the
45 moderate memory requirements of the bytecode compiler. The native-code
46 compiler currently runs on the following platforms:
47
48 |====
49 | | Tier 1 (actively maintained) | Tier 2 (maintained when possible)
50
51 | x86 64 bits | Linux, macOS, Windows, FreeBSD | NetBSD, OpenBSD
52 | x86 32 bits | Linux, Windows | FreeBSD, NetBSD, OpenBSD
53 | ARM 64 bits | Linux | FreeBSD
54 | ARM 32 bits | Linux | FreeBSD, NetBSD, OpenBSD
55 | Power 64 bits | Linux |
56 | Power 32 bits | | Linux
57 | IBM Z (s390x) | Linux |
58 |====
59
60 Other operating systems for the processors above have not been tested, but
61 the compiler may work under other operating systems with little work.
62
63
64 == Copyright
65
66 All files marked "Copyright INRIA" in this distribution are copyright 1996,
67 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
68 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019
69 Institut National de Recherche en Informatique et en Automatique (INRIA)
70 and distributed under the conditions stated in file LICENSE.
71
72 == Installation
73
74 See the file link:INSTALL.adoc[] for installation instructions on
75 machines running Unix, Linux, OS X and Cygwin. For native Microsoft
76 Windows, see link:README.win32.adoc[].
77
78 == Documentation
79
80 The OCaml manual is distributed in HTML, PDF, and Emacs
81 Info files. It is available at
82
83 http://caml.inria.fr/pub/docs/manual-ocaml/
84
85 == Availability
86
87 The complete OCaml distribution can be accessed at
88
89 http://ocaml.org/docs/install.html
90
91 == Keeping in Touch with the Caml Community
92
93 The OCaml mailing list is the longest-running forum for OCaml users.
94 You can email it at
95
96 mailto:caml-list@inria.fr[]
97
98 You can subscribe and access list archives via the Web interface at
99
100 https://sympa.inria.fr/sympa/subscribe/caml-list
101
102 You can also access a newer discussion forum at
103
104 https://discuss.ocaml.org/
105
106 There also exist other mailing lists, chat channels, and various other forums
107 around the internet for getting in touch with the OCaml and ML family language
108 community. These can be accessed at
109
110 http://ocaml.org/community/
111
112 In particular, the IRC channel `#ocaml` on https://freenode.net/[Freenode] has a
113 long history and welcomes questions.
114
115 == Bug Reports and User Feedback
116
117 Please report bugs using the issue tracker at
118 https://github.com/ocaml/ocaml/issues
119
120 To be effective, bug reports should include a complete program (preferably
121 small) that exhibits the unexpected behavior, and the configuration you are
122 using (machine type, etc).
123
124 For information on contributing to OCaml, see link:HACKING.adoc[] and
125 link:CONTRIBUTING.md[].
126