Skip to content

Commit

Permalink
doc: tighten wording in README.md
Browse files Browse the repository at this point in the history
<!-- ps-id: 8f83bbdb-4bbb-4c1f-8c9a-c3d6b276346a -->

Signed-off-by: Ali Caglayan <[email protected]>
  • Loading branch information
Alizter committed Dec 2, 2022
1 parent f244a6e commit 65a96bc
Showing 1 changed file with 24 additions and 26 deletions.
50 changes: 24 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,19 @@ Dune - A Composable Build System
[![Main workflow][workflow-badge]][workflow]
[![Release][release-img]][release]

Dune is a build system designed for OCaml/Reason projects only. It focuses on
providing the user with a consistent experience and takes care of most low-level
details of OCaml compilations. It's merely necessary to provide a description of
your project, and Dune will do the rest.
Dune is a build system for OCaml. It provides a consistent experience and takes
care of the low-level details of OCaml compilation. You need only to provide a
description of your project, and Dune will do the rest.

It implements a scheme that's inspired from the one used inside Jane Street and
adapted to the open source world. It has matured over a long time and is used
daily by hundreds of developers, meaning it's highly tested and productive.
Dune implements a scheme that's inspired from the one used inside Jane Street
and adapted to the open source world. It has matured over a long time and is
used daily by hundreds of developers, meaning it's highly tested and productive.

Dune comes with a [manual][manual]. If you want to get started without reading
too much, look at the [quick start guide][quick-start] or watch [this
introduction video][video].

The [example][example] directory contains examples of projects using dune.
The [example][example] directory contains examples of projects using Dune.

[manual]: https://dune.readthedocs.io/en/latest/
[quick-start]: https://dune.readthedocs.io/en/latest/quick-start.html
Expand All @@ -31,15 +30,14 @@ The [example][example] directory contains examples of projects using dune.
Overview
--------

Dune reads project metadata from `dune` files, which are either static files in
a simple S-expression syntax or OCaml scripts. It uses this information to setup
build rules, generate configuration files for development tools such as
[Merlin][merlin], handle installation, etc.
Dune reads project metadata from `dune` files, which are static files with a
simple S-expression syntax. It uses this information to setup build rules,
generate configuration files for development tools such as [Merlin][merlin],
handle installation, etc.

Dune itself is fast, has very low overhead, and supports parallel builds on all
platforms. It has no system dependencies. OCaml is all you need to build Dune
and packages using Dune. You don't need `make` or `bash`, as long as the
packages themselves don't use `bash` explicitly.
Dune itself is fast, has very little overhead, and supports parallel builds on
all platforms. It has no system dependencies. OCaml is all you need to build
Dune and packages using Dune.

In particular, one can install OCaml on Windows with a binary installer and then
use only the Windows Console to build Dune and packages using Dune.
Expand All @@ -49,16 +47,16 @@ Strengths

### Composable

Take *n* repositories that use Dune and arrange them in any way on the file
system. The result is still a single repository that Dune knows how to build at
once.
Dune is composable, meaning that multiple Dune projects can be arranged
together, leading to a single build that Dune knows how to execute. This allows
for monorepos of projects.

This make simultaneous development on multiple packages trivial.
Dune makes simultaneous development on multiple packages a trivial task.

### Gracefully Handles Multi-Package Repositories

Dune knows how to handle repositories containing several packages. When building
via [Opam][opam], it is able to correctly use libraries that were previously
via [opam][opam], it is able to correctly use libraries that were previously
installed, even if they are already present in the source tree.

The magic invocation is:
Expand All @@ -73,9 +71,9 @@ simultaneously. This helps maintaining packages across several versions of
OCaml, as you can test them all at once without hassle.

In particular, this makes it easy to handle
[cross-compilation](https://dune.readthedocs.io/en/latest/cross-compilation.html).
[cross-compilation][cross-compilation]. This feature requires [opam][opam].

This feature requires [Opam][opam].
[cross-compilation]: https://dune.readthedocs.io/en/latest/cross-compilation.html

Requirements
------------
Expand All @@ -86,13 +84,13 @@ using OCaml 4.02.3 or greater.
Installation
------------

We recommended installing Dune via the [Opam package manager][opam]:
We recommended installing Dune via the [opam package manager][opam]:

```sh
$ opam install dune
```

If you are new to Opam, make sure to run `eval $(opam config env)` to make
If you are new to opam, make sure to run `eval $(opam config env)` to make
`dune` available in your `PATH`. The `dune` binary is self-contained and
relocatable, so you can safely copy it somewhere else to make it permanently
available.
Expand Down Expand Up @@ -136,7 +134,7 @@ described in the [manual](http://dune.readthedocs.io/en/latest/migration.html).
Status
------

Dune is fairly stable and used by the majority of packages on Opam. Note that
Dune is fairly stable and used by the majority of packages on opam. Note that
Dune retains backward compatibility with Jbuilder, and in particular, existing
Jbuilder projects will continue to be buildable with Dune.

Expand Down

0 comments on commit 65a96bc

Please sign in to comment.