aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorCalvin Rose <calsrose@gmail.com>2019-05-17 09:48:08 -0400
committerCalvin Rose <calsrose@gmail.com>2019-05-17 09:48:08 -0400
commit43c0db4b0ef3dccd43a8c99a2e15baf29071afcb (patch)
tree5321379d960aa1ba70724f65bbe6514d263e1a07 /README.md
parentMerge pull request #105 from andrewchambers/doc (diff)
Add FAQ to readme for color terminal issues.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3fd501d5..f9e40354 100644
--- a/README.md
+++ b/README.md
@@ -184,6 +184,16 @@ See the examples directory for some example janet code.
Feel free to ask questions and join discussion on the [Janet Gitter Channel](https://gitter.im/janet-language/community).
Alternatively, check out [the #janet channel on Freenode](https://webchat.freenode.net/)
+## FAQ
+
+### Why is my terminal is spitting out junk when I run the repl?
+
+Make sure your terminal supports ANSI escape codes. Most modern terminals will
+support these, but some older terminals, windows consoles, or embedded terminals
+will not. If your terminal does not support ANSI escape codes, run the repl with
+the `-n` flag, which disables color output. You can also try the `-s` if further issues
+ensue.
+
## Why Janet
Janet is named after the almost omniscient and friendly artificial being in [The Good Place](https://en.wikipedia.org/wiki/The_Good_Place).