From 4a1689df2fcc00b82aa8f6200c9e53cbc786e2ad Mon Sep 17 00:00:00 2001 From: Adrian Cochrane Date: Fri, 9 Aug 2019 10:32:36 +1200 Subject: [PATCH] Add contribution instructions. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 68f190d..0245963 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Stylish Haskell +# Haskell Stylist Generic CSS style engine for Haskell, intended to aid the development of new browser engines. Stylish Haskell implements CSS selection and cascade (but not inheritance) independant of the CSS at-rules and properties understood by the caller. It is intended to ease the development of new browser engines, independant of their output targets. @@ -16,3 +16,8 @@ To parse a CSS stylesheet call `Data.CSS.Syntax.StyleSheet.parse` which returns If these ultimately call down into a `Data.CSS.Syntax.Style.QueryableStyleSheet` you can call `queryRules` to find all matching style rules organized by psuedoelement. Once you have these style rules (typically by specifying a psuedoelement) you can call `cascade'` to resolve them into any instance of `PropertyParser`. To query rules not targetting a psuedoelement, you can either lookup the "" psuedoelement or use the `cascade` shorthand. `PropertyParser` allows to declaratively (via Haskell pattern matching) specify how to parse CSS properties, and how they're impacted by CSS inheritance. It has four methods: `longhand` and `shorthand` specify how to parse CSS properties, whilst `temp` and `inherit` specifies what the default values should be. + +## Contributing +You can contributed code or register "issues" to Haskell Stylist by contacting me (Adrian Cochrane) via [mastodon](https://floss.social/@alcinnz/) or [email](mailto:adrian@openwork.nz). Or you can sign up for an account on the NZ OSS GitLab. + +If you're contributing code you can link me to where you're hosting your git fork, or send [a patch file](https://git-send-email.io/). Or if you simply to ask for more features or fixes don't hesitate to contact me! -- 2.30.2