Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add description of Xcode and Windows to install file, Fixes #10281 #10685

Merged
merged 12 commits into from
Nov 5, 2021
Merged

Add description of Xcode and Windows to install file, Fixes #10281 #10685

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f65ffc7
Add the description of Xcode to the INSTALL file.
kirisky Oct 8, 2021
a77c26e
Add description for Windows
kirisky Oct 8, 2021
30cc034
Make Checks happy
kirisky Oct 8, 2021
1d01832
Make Checks happy
kirisky Oct 8, 2021
71515d0
Add a record to Change file
kirisky Oct 8, 2021
029ec62
Change the description of the Windows part.
kirisky Oct 9, 2021
e41b8f6
Correct the link of README.win32.adoc
kirisky Oct 9, 2021
768eccb
Correct a type
kirisky Oct 9, 2021
eba3602
1. Correct the wrong link for README.win32.adoc.
kirisky Oct 10, 2021
63007e8
add WSL to installation part on README.adoc
kirisky Oct 10, 2021
8a85da3
1. Remove unnecessary pluses.
kirisky Oct 12, 2021
80c70c0
Merge branch 'trunk' into add-xcode-description-to-INSTALL-file
xavierleroy Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions Changes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ Working version
(Nicolás Ojeda Bär, report by Daniel Bünzli, review by David Allsopp,
Sébastien Hinderer, and Daniel Bünzli)

- #10281: Add description of C compiler on macOS and Windows platforms.
(Dong An, review by Xavier Leroy and David Allsopp)

### Compiler user-interface and warnings:

- #10328: Give more precise error when disambiguation could not possibly work.
Expand Down
17 changes: 15 additions & 2 deletions INSTALL.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,23 @@
== Prerequisites

* A C Compiler is required.
The GNU C Compiler (`gcc`) is recommended as the bytecode interpreter takes
** For GNU/Linux +
The GNU C Compiler (`gcc`) is recommended as the bytecode interpreter takes
advantage of GCC-specific features to enhance performance. gcc is the standard
kirisky marked this conversation as resolved.
Show resolved Hide resolved
compiler under Linux and many other systems.
However `clang` - used in Mac OS, BSDs and others - also works fine.

** For BSDs +
`Clang` is the default C compiler under BSDs - also works fine.

** For MacOS +
`Clang` is the default C compiler under MacOS. If MacOS complains no C compiler was installed while OCaml installing,
please run command `xcode-select --install` to install command-line tools and required libraries and header files.

** For Windows +
To produce native Windows executables from OCaml sources, you need to use the MSVC or Mingw ports of
OCaml, described in file https://github.com/ocaml/ocaml/blob/trunk/README.win32.adoc[README.win32.adoc]. +
For a more Unix-like experience, you can use WSL, the https://aka.ms/wsl[Windows Subsystem for Linux],
or the https://www.cygwin.com/[Cygwin environment]. You will need the GCC compiler (package `gcc-core` or `gcc`).
kirisky marked this conversation as resolved.
Show resolved Hide resolved

* GNU `make`, as well as POSIX-compatible `awk` and `sed` are required.

Expand Down
2 changes: 1 addition & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ file LICENSE.
== Installation

See the file link:INSTALL.adoc[] for installation instructions on
machines running Unix, Linux, macOS and Cygwin. For native Microsoft
machines running Unix, Linux, macOS, WSL and Cygwin. For native Microsoft
Windows, see link:README.win32.adoc[].

== Documentation
Expand Down