aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjeremie giffard <e132784f@gmail.com>2023-04-16 20:10:51 +0200
committerMauricio Antunes <mauricio.abreua@gmail.com>2023-04-16 20:24:53 -0300
commit26a1a23065d29a3538f8684edbe6d433754267fd (patch)
treeab4014596fabf1965a4d80301b17161ad3e86290 /README.md
parent3560ebf94b8b8bb6e06e800bce629c28ba7c18f5 (diff)
fix: help command and add it to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index ea52a95..ef12c04 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,12 @@ To compile and run all the exercises:
golings verify
```
+If you need help with CLI commands:
+
+```sh
+golings --help
+```
+
A demo running the command `golings run <exercise name>`
![demo](misc/demo.gif)
@@ -81,11 +87,11 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
## Learning resources
-* [Golang official tutorial](https://go.dev/doc/tutorial/)
-* [Go by example](https://gobyexample.com)
-* [Aprenda Go](https://www.youtube.com/playlist?list=PLCKpcjBB_VlBsxJ9IseNxFllf-UFEXOdg)
+- [Golang official tutorial](https://go.dev/doc/tutorial/)
+- [Go by example](https://gobyexample.com)
+- [Aprenda Go](https://www.youtube.com/playlist?list=PLCKpcjBB_VlBsxJ9IseNxFllf-UFEXOdg)
## Other 'lings
-* [rustlings](https://github.com/rust-lang/rustlings)
-* [ziglings](https://github.com/ratfactor/ziglings)
+- [rustlings](https://github.com/rust-lang/rustlings)
+- [ziglings](https://github.com/ratfactor/ziglings)