Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #6 from mechanical-snail/patch-1

Modify README to better explain the relation with UnicodeSyntax
  • Loading branch information...
commit 14afd87a3d98d1dec55afb6f646a308c56d8010d 2 parents ebda05e + 153c0ac
@roelvandijk authored
Showing with 14 additions and 8 deletions.
  1. +14 −8 README.markdown
View
22 README.markdown
@@ -1,14 +1,20 @@
-This package defines new symbols for a number of functions and
-operators in the base package.
+This package defines Unicode symbol aliases for a number of functions and
+operators in the `base` package of the Haskell standard library.
+Many of these aliases enable the use of standard mathematical notation in place of ASCII approximations or textual names.
+For example, `(∧)` (U+2227 LOGICAL AND) can be used in place of `(&&)` for boolean AND.
-All symbols are documented with their actual definition and
-information regarding their Unicode code point. They should be
+All symbols are documented with their actual definition and their Unicode code point. They should be
completely interchangeable with their definitions.
-For further Unicode goodness you can enable the
-[UnicodeSyntax](http://www.haskell.org/ghc/docs/latest/html/users_guide/syntax-extns.html#unicode-syntax)
+# Versus the `UnicodeSyntax` language extension
+
+This library only provides Unicode aliases for *library* functions.
+If you want to use Unicode symbols for core language tokens, also enable the
+[`UnicodeSyntax`](http://www.haskell.org/ghc/docs/latest/html/users_guide/syntax-extns.html#unicode-syntax)
language extension. This extension enables Unicode characters to be
-used to stand for certain ASCII character sequences, i.e. → instead of
-`->`, ∀ instead of `forall` and many others.
+used to stand for certain ASCII character sequences, i.e. `→` instead of
+`->`, `∀` instead of `forall` and many others.
+
+# Credits
Original idea by Péter Diviánszky.
Please sign in to comment.
Something went wrong with that request. Please try again.