From 4d6512b2c83fc41c78d93cfa468214fdd0ccf634 Mon Sep 17 00:00:00 2001 From: rigor Date: Thu, 5 Sep 2024 20:38:52 -0500 Subject: [PATCH] doc: populated main readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d28633..5f97325 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # examples -A collection of small code tests and examples to reference later. \ No newline at end of file +A collection of small code tests and examples to reference later. + +## Warning: + +I make no guarantees as to the functionality, quality, or state of any example +in this repository. + +You have been warned. + +## Layout + +This repository is divided based on the tool being tested, with all top-level +directories referencing a language (if applicable) or a tool (if a language is +not applicable). + +The second layer of directories will each be tests for a single feature, +library, functionality, etc.