diff --git a/README.md b/README.md index d5650cc..2320092 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,7 @@ A basic programming language written in Nim The project is split into several directories and submodules: - `build.py` -> The build script (TODO, not pushed yet) - `docs` -> Contains markdown files with the various specifications for NimVM (bytecode, grammar, etc) - - `docs/bytecode.md` -> Lays out the bytecode specification for NimVM as well as serialization guidelines (TODO) - - `docs/grammar.md` -> Formal grammar specification in EBNF syntax - `src` -> Contains source files - - `src/main.nim` -> This is the main executable for NimVM (REPL, run files, etc.), currently not in this repo - - `src/backend` -> Contains the backend of the language (lexer, parser and compiler) - - `src/backend/meta` -> Contains meta-structures that are used during parsing and compilation - - `src/backend/lexer.nim` -> Contains the tokenizer - - `src/backend/parser.nim` -> Contains the parser - - `src/backend/compiler.nim` -> Contains the compiler (TODO) - - `src/frontend` -> Contains the language's frontend (runtime environment and type system) (TODO) - - `src/frontend/types` -> Contains the implementation of the type system (TODO) - - `src/frontend/vm.nim` -> Contains the virtual machine (stack-based) - - `src/util` -> Contains generic utilities used troughout the project (TODO) - - `src/util/bytecode` -> Contains the bytecode serializer/deserializer (TODO) - - `src/util/bytecode/serializer.nim` -> Contains the bytecode serializer (TODO) - - `src/util/bytecode/deserializer.nim` -> Contains the bytecode deserializer (TODO) - - `src/util/bytecode/objects.nim` -> Contains object wrappers for bytecode opcodes (TODO) - - `src/util/debug.nim` -> Contains the debugger (TODO) - - `src/util/optimizer.nim` -> Contains the optimizer (TODO) ## Language design