Commit 2441fd83 authored by Marc Coiffier's avatar Marc Coiffier
Browse files

Put some backquotes in the README

parent d1a221e2
......@@ -14,7 +14,7 @@ and ready-to-use version.
Here is a short description of the different packages in this BHR.
### The definitive-* libraries
### The `definitive-*` libraries
Those are basic libraries, designed to minimize external dependencies
while providing most of the functionality found in modern Haskell
......@@ -22,48 +22,48 @@ programs. Most notably, optics (Lenses and the like) are defined very
early on in the definitive-base library, and serve as the basis for
many standard abstractions.
The definitive-base library defines all the standard Monad transformer
combinators, from StateT to LogicT, along with a generalization of the
containers library that simplifies the use of Sets and Maps, and
introduces the Bimap, Relation and Equiv containers under the same
interface.
The definitive-parser library, as it name indicates, defines the usual
parser combinators (using the LogicT transformer for non-determinism),
and is used for both binary and textual parsing in most other
packages. It also defines Serializable and Format typeclasses, as well
as their instances for most basic data types and a mechanism for
automatic derivation of those classes for types that are instances of
the Generic class.
The definitive-graphics library provides high-level wrappers for the
The `definitive-base` library defines all the standard Monad
transformer combinators, from StateT to LogicT, along with a
generalization of the containers library that simplifies the use of
Sets and Maps, and introduces the Bimap, Relation and Equiv containers
under the same interface.
The `definitive-parser` library, as it name indicates, defines the
usual parser combinators (using the LogicT transformer for
non-determinism), and is used for both binary and textual parsing in
most other packages. It also defines Serializable and Format
typeclasses, as well as their instances for most basic data types and
a mechanism for automatic derivation of those classes for types that
are instances of the Generic class.
The `definitive-graphics` library provides high-level wrappers for the
GTK windowing framework, allowing one to describe GUIs and their
behaviour in the perfect mix of declarative layout and imperative
event handling.
The other two (definitive-network and definitive-filesystem) are much
less interesting, and should definitely not be included in any serious
project.
The other two (`definitive-network` and `definitive-filesystem`) are
much less interesting, and should definitely not be included in any
serious project.
### The Curly compiler and libraries
The packages whose name start with 'curly' are part of the Curly
compiler infrastructure (more information on
The packages whose name start with `curly` are part of the Curly
compiler infrastructure (on which more information can be found at
[curly-lang.org](https://www.curly-lang.org/)).
The 'curly' package contains the library that describes how the
The `curly` package contains the library that describes how the
compiler interacts with its environment (reads configuration files,
locates packages, host interactive sessions, ...). Using that library,
it also implements the 'curly' executable, aka the compiler. The
'curly' library is also used by 'curly-gui' to handle all
context-related operations.
it also implements the `curly` executable, aka the compiler
itself. The `curly` library is also used by `curly-gui`, a GUI version
of the compiler, to handle all its context-related operations.
At a lower level, the 'curly-system' library contains the
At a lower level, the `curly-system` library contains the
implementation of all of Curly's backends, from x86 assembly to
JavaScript. You could write a basic batch compiler using only this
library.
All of the above packages depend on the 'curly-core' library, which
All of the above packages depend on the `curly-core` library, which
defines all the aspects of the core language, in an
architecture-independent way. This is where you can find a description
of the object format (in the Library type), the type system, and the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment