From a1c1745c86a47f28a219c660407d073911cade5f Mon Sep 17 00:00:00 2001 From: Scott Wadden Date: Mon, 13 Nov 2023 16:05:27 -0400 Subject: [PATCH] Doc updates --- README.md | 9 +++++---- docs/book/goals.md | 29 +++++++++++++++-------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e77afb61..812f217d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Enu -3D live coding, implemented in Nim. +Build 3D worlds in Nim. -![Enu Screenshot](media/screenshot_2.png) +![Enu Screenshot](media/screenshot_3.webp) -Enu lets you build and explore worlds using a familiar block-building interface and a Logo inspired API. -It tries to make 3D development more accessible, and will eventually be usable to create standalone games. +Enu lets you build and explore worlds using a familiar block-building interface +and a Logo inspired API. It tries to make 3D development easier, and will +eventually be able to create standalone games. diff --git a/docs/book/goals.md b/docs/book/goals.md index 6dcf43a0..c7e31627 100644 --- a/docs/book/goals.md +++ b/docs/book/goals.md @@ -1,8 +1,8 @@ # Goals -Enu is meant for anyone who wants to explore, experiment, or make games, but -particular care has been taken to make it usable by children However, rather -than bypassing the keyboard with a Scratch-like visual programming language, +Enu is meant for anyone who wants to explore, experiment, or make games, but +particular care has been taken to make it usable by children However, rather +than bypassing the keyboard with a Scratch-like visual programming language, Enu attempts to reduce and simplify the keystrokes required for a text-based language, while (hopefully) preserving most of the flexibility text-based code offers. @@ -10,21 +10,22 @@ offers. With this in mind, Enu tries to: - Reduce nesting. Indentation can be tricky for new programmers. -- Reduce the use of the shift key. Lower case is used almost everywhere. - Commands are written to avoid underscores and parenthesis. By default (for - now at least), a `;` keypress is interpreted as `:`, as `:` is used - frequently in Nim (and requires shift, at least on US English keyboards) - while `;` is not. - -- Omit or shorten identifier names. `me` instead of `self/this`. `-` instead - of `proc`. `5.times:` or `5.x:` instead of `for i in 0..5:`. Single letter + +- Reduce the use of the shift key. Lower case is used almost everywhere. + Commands are written to avoid underscores and parenthesis. Optionally, Enu can + be [configured](intro/config.html) to interpret a `;` keypress as `:`, as `:` + is used frequently in Nim (and requires shift, at least on US English + keyboards) while `;` is not. + +- Omit or shorten identifier names. `me` instead of `self/this`. `-` instead + of `proc`. `5.times:` or `5.x:` instead of `for i in 0..5:`. Single letter shortcuts for many common commands. -- Pretends to avoid types. Enu code is Nim code and is statically typed, but - types are inferred or auto-converted where possible. Types are great, +- Pretends to avoid types. Enu code is Nim code and is statically typed, but + types are inferred or auto-converted where possible. Types are great, but are confusing for new programmers. -- Spatial organization. No files. Code is text, but it's accessed through an +- Spatial organization. No files. Code is text, but it's accessed through an object in the virtual world. - Avoids events. Tries to make all flow based on loops and conditionals.