Skip to content

Commit 0855048

Browse files
committed
doc: updated README
1 parent bc4c3d2 commit 0855048

File tree

4 files changed

+8
-303
lines changed

4 files changed

+8
-303
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,27 +81,22 @@ Tested with:
8181
* [GHC](https://www.haskell.org/ghc/) 7.10.3 to 9.4.2 (x64)
8282

8383

84-
* [GHCJS](https://github.com/ghcjs/ghcjs)
85-
86-
* Note: versions of `flat` prior to 0.33 encode `Double` values incorrectly when they are not aligned with a byte boundary.
87-
84+
* [GHCJS](https://github.com/ghcjs/ghcjs) version 8.6.0.1 (GHC 8.6.2)
8885

8986

9087
### Known Bugs and Infelicities
9188

92-
* Data types with more than 512 constructors are currently unsupported
89+
* Data types with more than 512 constructors are currently unsupported (but support could be easily added if necessary)
9390

9491
* Longish compilation times
9592

96-
* `flat` relies more than other serialisation libraries on extensive inlining for its good performance, this unfortunately leads to longer compilation times.
97-
98-
If you have many data types or very large ones this might become an issue.
93+
* To improve performance, `flat` relies on extensive inlining. This unfortunately leads to longer compilation times.
9994

100-
A couple of good practices that will eliminate or mitigate this problem are:
95+
If you have many data types or very large ones, you might want to:
10196

10297
* During development, turn optimisations off (`stack --fast` or `-O0` in the cabal file).
10398

104-
* Keep your serialisation code in a separate module or modules.
99+
* Keep your serialisation code in separate modules.
105100

106101
* See also the [full list of open issues](https://github.com/Quid2/flat/issues).
107102

src/README-EXE.hs

Lines changed: 0 additions & 149 deletions
This file was deleted.

0 commit comments

Comments
 (0)