Skip to content

Commit

Permalink
Release 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
marhop committed Oct 21, 2018
1 parent 72b75c9 commit 6db25d2
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
37 changes: 37 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
The `lb` tool uses [semantic versioning][semver] which is summarized as follows:

> Given a version number MAJOR.MINOR.PATCH, increment the:
>
> 1. MAJOR version when you make incompatible API changes,
> 2. MINOR version when you add functionality in a backwards-compatible manner,
> and
> 3. PATCH version when you make backwards-compatible bug fixes.
Semantic versioning requires software to declare a public API. The public API of
`lb` is defined by two components:

1. The command line interface syntax (switches, options, arguments).
2. The hex code "mini language" understood by `lb` (hex characters, macros,
comments).

[semver]: https://semver.org/

# Release 1.1.0 (2018-10-21)

It is now possible to create really large files. For example, hex code like
`(41){5368709000}`, resulting in 5 GB of data, can be compiled regardless of the
available RAM. (It may take some time though.) Prior to this release, this would
cause memory errors.

With the new CLI option `--plain` (or `-p`), hex code without surrounding
Markdown is accepted as input, allowing quick tests like this:

$ echo '(00ff){42} 0a' | lb --plain

The new CLI option `--version` prints the current version number.

Error messages have been improved.

# Release 1.0.0 (2018-09-05)

Initial release.
2 changes: 1 addition & 1 deletion literate-binary.cabal
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: literate-binary
version: 1.0.0
version: 1.1.0
synopsis: Integrate handcrafted binary and documentation
homepage: https://github.com/marhop/literate-binary
license: MIT
Expand Down
2 changes: 1 addition & 1 deletion src/Main.hs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ getOpts =
execParser $ info (helper <*> version <*> options) (fullDesc <> header hdr)
where
hdr = "lb - literate binary compiler"
version = infoOption "1.0.0" (long "version" <> help "Show version number")
version = infoOption "1.1.0" (long "version" <> help "Show version number")
options = Options <$> input <*> output <*> plain
input =
optional $
Expand Down

0 comments on commit 6db25d2

Please sign in to comment.