From 18c71f41fe5a32e74ca41b3d545450161dfa98c9 Mon Sep 17 00:00:00 2001 From: prod2 <95874442+prod2@users.noreply.github.com> Date: Sat, 3 Dec 2022 20:21:18 +0100 Subject: [PATCH] more polish to .md files --- README.md | 9 +++------ docs/reference.md | 8 -------- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8700bd3..4947362 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,15 @@ # nondescript -Nondescript is a toy programming language. Currently its compiler is being rewritten, so please check the latest commit from Feb 2022 to see a working version in action. - -# Some of nondescript's features +Nondescript is a toy programming language. Some of its features are: - Dynamic typing, bytecode interpreter - Almost everything is an expression +- New, rewritten 2 pass compiler (parsing, emitting) - Syntax tries to balance sugar with consistency See [docs/reference.md](docs/reference.md) to learn more about the language. -## Examples - -If the [docs/](docs/) folder is not enough, the following folders in the source tree, will have more examples: +If that document is not enough, the following folders in the source tree, will have more examples: - benchmarks/ - examples/ diff --git a/docs/reference.md b/docs/reference.md index ab06c92..ef04d03 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,5 +1,3 @@ -Note: this is a work in progress. - Sections: 1. User's manual to nondescript 2. Design notes @@ -265,10 +263,6 @@ TODO very incomplete section # Roadmap -(All the hidden todo.txt's were cleaned up. Here is a public list of everything that was on them that is still relevant.) - -First, compiler v2 has to be completed. - The following features are currently missing, and may or may not be added to nds: - Garbage collection - `for (i in list) expr` type expressions for iterating lists, tables @@ -296,6 +290,4 @@ The following optimizations could be added: # Known bugs -(Note: might not be an exhaustive list of bugs I know of, sorry) - - printing self referential tables results in endless loop \ No newline at end of file