aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2019-10-27 20:51:54 +0000
committerLouis Pilfold <louis@lpil.uk>2019-10-27 20:54:18 +0000
commitb6c291ae0c0122ae70681bcdcda723f43450a7e8 (patch)
tree5bc8103040d9083aa5aaffcded8a2796d64bec8e
parent85f2f8152471a4fdaa9639ec92cd54e4ad0e1117 (diff)
downloadgleam_stdlib-b6c291ae0c0122ae70681bcdcda723f43450a7e8.tar.gz
gleam_stdlib-b6c291ae0c0122ae70681bcdcda723f43450a7e8.zip
Split from compiler repository
-rw-r--r--.gitattributes12
-rw-r--r--README.md18
2 files changed, 19 insertions, 11 deletions
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..2c77e1d
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,12 @@
+# We want fancy syntax highlighting on GitHub, though GitHub doesn't know how
+# to speak Gleam. Until it does (maybe one day!) we'll tell GitHub that these
+# files are Rust, which has a similar enough syntax for the highlighting to
+# work in most cases.
+# The only caveat is that we need to add a `;` after each use of the `type`
+# keyword as our type syntax is different to theirs in a way that confuses
+# GitHub.
+*.gleam linguist-language=Rust
+
+# Erlang files generated by the Gleam compiler
+/gen/*/*.erl linguist-generated=true
+/docs/**/* linguist-generated=true
diff --git a/README.md b/README.md
index 98874ab..514e8ea 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,10 @@
-gleam_stdlib
-=====
+# Gleam stdlib
-An OTP library
+Gleam's standard library!
-Build
------
+## Quick reference
- $ rebar3 compile
-
-Run Tests
------
-
- $ rebar3 eunit
+```sh
+# Run the unit tests
+rebar3 eunit
+```