Skip to content

Commit 01466f0

Browse files
committed
[ README ] Update: Alex is for GHC >= 7.0
- Removed some outdated stuff that sold Alex 2 when we already have Alex 3. - Alex 3 is no longer for "Haskell 98 with hierarchical modules" and "GHC >= 5.04"; CI only tests for ghc >= 7.0. - Link to contribution list on github.
1 parent 1711344 commit 01466f0

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,14 @@ documentation, see the doc directory.
99

1010
- <https://hackage.haskell.org/package/alex>
1111

12-
Alex version 2.0 has changed fairly considerably since version 1.x,
13-
and the syntax is almost completely different. For a detailed list of
14-
changes, see the release notes in the documentation.
12+
Alex is covered by a BSD-Style licence; see the licence file in
13+
the `doc` directory for details.
1514

16-
Alex is now covered by a BSD-Style licence; see the licence file in
17-
the 'doc' directory for details.
15+
The sources are in the `src` directory and the documentation in the `doc`
16+
directory; various examples are in the `examples` subdirectory.
1817

19-
The sources are in the 'src' directory and the documentation in the 'doc'
20-
directory; various examples are in the 'examples' subdirectory.
21-
22-
The source code in the 'src' and 'examples' directories is intended
23-
for a Haskell 98 compiler with hierarchical modules. It should work
24-
with GHC >= 5.04.
18+
The source code in the `src` and `examples` directories is intended to work
19+
with GHC >= 7.0.
2520

2621
## Build Instructions
2722

@@ -51,7 +46,7 @@ Haskell Platform, or e.g. via (run this outside the Git repository!):
5146
$ cabal install alex happy
5247

5348
which installs them into `${HOME}/.cabal/bin` by default (make sure
54-
they're in your `$PATH` for the next steps!).
49+
they are in your `$PATH` for the next steps!).
5550

5651
### Variant A
5752

@@ -65,7 +60,7 @@ First you need to generate the pre-processed templates via
6560
And then you can install `alex` simply by invoking
6661

6762
$ cabal install
68-
63+
6964
from inside the Git folder.
7065

7166
### Variant B
@@ -78,7 +73,7 @@ new-run gen-alex-sdist` pre-preprocessing step):
7873
$ make sdist
7974
$ cabal install dist/alex-*.tar.gz
8075

81-
For convenience, there's also a `make sdist-test` target which builds the
76+
For convenience, there is also a `make sdist-test` target which builds the
8277
source source tarball and runs the test-suite from within the source dist.
8378

8479
## Contributing & Reporting Issues
@@ -92,3 +87,5 @@ Chris Dornan: [email protected]
9287
Isaac Jones: [email protected]
9388

9489
Simon Marlow: [email protected]
90+
91+
and [recent contributors](https://github.com/simonmar/alex/graphs/contributors).

0 commit comments

Comments
 (0)