diff options
| -rw-r--r-- | .gitattributes | 12 | ||||
| -rw-r--r-- | README.md | 18 |
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 @@ -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 +``` |