From bccdab1a327ee81788ae06a3251a328845bd1202 Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Mon, 6 Feb 2023 01:58:25 +1100 Subject: [PATCH] Added about library --- README.md | 1 + about-library.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 about-library.md diff --git a/README.md b/README.md index 4eacd33..cf923c7 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ print tally(); //3 * [Quick Start Guide](quick-start-guide) * [Types](types) * [Standard Library](standard-library) +* [About Library](about-library) * [Compound Library](compound-library) (under development) * [Timer Library](timer-library) * [Runner Library](runner-library) diff --git a/about-library.md b/about-library.md new file mode 100644 index 0000000..6d74568 --- /dev/null +++ b/about-library.md @@ -0,0 +1,31 @@ +# About Library + +The about library simply provides version info about the current build of Toy. + +The about library can usually be accessed with the `import` keyword: + +``` +import about; +import about as about; //can easily be aliased +``` + +## major + +This variable is the major version number of Toy at the time of compilation. + +## minor + +This variable is the minor version number of Toy at the time of compilation. + +## patch + +This variable is the patch version number of Toy at the time of compilation. + +## build + +This variable is a string representing the date and time that the interpreter was compiled. + +## author + +This variable contains the name of Toy's lead author, and his game studio. +