lib: add a README for standard

[nit.git] / lib / standard / README.md

diff --git a/lib/standard/README.md b/lib/standard/README.md
new file mode 100644 (file)
index 0000000..cd780d0
--- /dev/null
+++ b/lib/standard/README.md
@@ -0,0 +1,46 @@
+# Nit Core Library
+
+Core classes and methods used by default by Nit programs and libraries.
+
+## Core Basic Types and Operations
+
+[[doc:kernel]]
+
+### Object
+
+[[doc:Object]]
+
+#### Equality
+
+[[doc:Object::==]]
+[[doc:Object::!=]]
+[[doc:Object::hash]]
+[[doc:Object::is_same_instance]]
+[[doc:Object::object_id]]
+
+#### Debuging
+
+[[doc:Object::output]]
+[[doc:Object::output_class_name]]
+[[doc:Object::is_same_type]]
+
+### Sys
+
+[[doc:Sys]]
+
+#### Program Execution
+
+[[doc:Sys::main]]
+[[doc:Sys::run]]
+
+### Other
+
+[[list:kernel]]
+
+## Core Collections
+
+[[doc:collection]]
+
+## String and Text manipulation
+
+[[doc:text]]