From 2d8fe15abbc867b3391333a441c327c3412533a3 Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Tue, 20 Aug 2024 12:37:54 +0200 Subject: [PATCH] Updated documentation --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 91aedf2..7fa9087 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # q -A simple programming language. +A programming language for use in systems programming, game development and web servers. ## Features * Fast compilation -* Small binaries +* Small executables * High performance ## Installation @@ -24,6 +24,18 @@ Build an executable from `examples/hello` and run it: ./q run examples/hello ``` +## Tests + +```shell +go test ./... -v -cover +``` + +## Benchmarks + +```shell +go test ./tests -run='^$' -bench=. -benchmem +``` + ## Todo ### Compiler @@ -178,18 +190,6 @@ This is what generates the AST from tokens. This is what generates expressions from tokens. -## Tests - -```shell -go test ./... -v -cover -``` - -## Benchmarks - -```shell -go test ./tests -bench=. -benchmem -``` - ## License Please see the [license documentation](https://akyoto.dev/license).