Skip to content

Commit

Permalink
Update project synopsis in README
Browse files Browse the repository at this point in the history
  • Loading branch information
FiniteReality committed Feb 21, 2022
1 parent 1cb7aeb commit b2f8d0f
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ via direct message on Discord or by contacting us via

This is a rough synopsis of the project structure as it stands today:

#### `cli` ####
#### `compiler` ####

A small command-line utility for evaluating Fabulist scripts.
The Fabulist compiler library and frontend, for translating Fabulist files to
an intermediate format used by the runtime.

#### `docs` ####

Expand All @@ -37,10 +38,14 @@ testing. As the language is fleshed out, there will be more examples added here.
Effectively scratch space, this directory is used for rapid development and
prototyping of Fabulist syntax.

#### `src` ####
#### `runtime` ####

The implementation of the Fabulist runtime, in ABI-portable C++.

#### `samples` ####

Samples using the Fabulist compiler or runtime.

#### `thirdparty` ####

Third-party dependencies which are automatically retrieved by CMake.
Expand All @@ -51,7 +56,6 @@ Before building Fabulist, you need to install some dependencies, and ensure
they can be located by CMake

#### Dependencies ####
1. Lua 5.1 (Version TBD) (Debian-derivatives: `liblua5.1-0-dev`)
2. A C++ compiler supporting C++17 (Debian-derivates: `build-essential`)
3. CMake 3.18 (Debian-derivatives: `cmake`)

Expand Down

0 comments on commit b2f8d0f

Please sign in to comment.