Skip to content

Commit e38f138

Browse files
committed
docs: add markdown readme
1 parent e34bc19 commit e38f138

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# megaparsec-utils
2+
Utilities to use on top of the
3+
[Megaparsec](https://hackage.haskell.org/package/megaparsec) library.
4+
5+
# Running tests
6+
Make sure your build passes tests using [Stack](https://docs.haskellstack.org/en/stable/).
7+
8+
# Contributing
9+
This repository uses [Conventional
10+
Commits](https://www.conventionalcommits.org/en/v1.0.0/) to generate versions
11+
with [Semantic Release](https://github.com/semantic-release/semantic-release),
12+
so make sure your commits are compliant. Pull requests are rebased, not
13+
squashed, so make sure your commits make sense as well.

README.org

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

package.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ maintainer: [email protected]
66
copyright: 2024 drlkf
77

88
extra-source-files:
9-
- README.org
10-
- CHANGELOG.md
9+
- README.md
10+
- CHANGELOG.md
1111

1212
description: Utilities for the Megaparsec library.
1313

0 commit comments

Comments
 (0)