summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorJohn Whitington <john@coherentgraphics.co.uk>2016-05-29 19:39:48 +0100
committerJohn Whitington <john@coherentgraphics.co.uk>2016-05-29 19:39:48 +0100
commite382d582a524e8d37c6a27fb354fe37505f9db48 (patch)
tree4626c8807f516d3997f6b057866dae036bafafc3 /README.adoc
parent2ba04edd10979860d41c32ab5e60028e8d0dbe76 (diff)
downloadocaml-e382d582a524e8d37c6a27fb354fe37505f9db48.tar.gz
Describe every top-level file and directory in the distribution
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index ca35134107..ffbe6fdb50 100644
--- a/README.adoc
+++ b/README.adoc
@@ -46,26 +46,41 @@ renaming of standard library functions.
== Contents
+ appveyor.yml:: configuration for appveyor CI
+ appveyor_build.sh:: appveyor CI script
Changes:: what's new with each release
+ configure:: configure script
+ CONTRIBUTING.md:: how to contribute to OCaml
INSTALL.adoc:: instructions for installation
LICENSE:: license and copyright notice
Makefile:: main Makefile
+ Makefile.nt:: MS Windows Makefile
+ Makefile.shared:: common Makefile
+ Makefile.tools:: used by manual/ and testsuite/ Makefiles
README.adoc:: this file
README.win32.adoc:: info on the MS Windows ports of OCaml
+ VERSION:: version string
asmcomp/:: native-code compiler and linker
asmrun/:: native-code runtime library
boot/:: bootstrap compiler
bytecomp/:: bytecode compiler and linker
byterun/:: bytecode interpreter and runtime system
+ compilerlibs/:: the OCaml compiler as a library
config/:: autoconfiguration stuff
debugger/:: source-level replay debugger
driver/:: driver code for the compilers
emacs/:: editing mode and debugger interface for GNU Emacs
+ experimental/:: experiments not built by default
+ flexdll/:: empty (see README.win32.adoc)
lex/:: lexer generator
+ man/:: man pages
+ manual/:: system to generate the manual
+ middle_end/:: the flambda optimisation phase
ocamldoc/:: documentation generator
otherlibs/:: several external libraries
parsing/:: syntax analysis
stdlib/:: standard library
+ testsuite/:: tests
tools/:: various utilities
toplevel/:: interactive system
typing/:: typechecking