aboutsummaryrefslogtreecommitdiff
path: root/display_lib/README.md
diff options
context:
space:
mode:
authorPierre-Yves Rollo <dev@pyrollo.com>2015-11-11 14:26:39 +0100
committerPierre-Yves Rollo <dev@pyrollo.com>2015-11-11 14:26:39 +0100
commitd44bf53ea20136221d605e139f2b58328b68ce9c (patch)
tree4f747301de219c9743b19efe536f340af90ce5ff /display_lib/README.md
downloaddisplay_modpack_no_craft-d44bf53ea20136221d605e139f2b58328b68ce9c.tar.gz
display_modpack_no_craft-d44bf53ea20136221d605e139f2b58328b68ce9c.zip
First commit
Diffstat (limited to 'display_lib/README.md')
-rw-r--r--display_lib/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/display_lib/README.md b/display_lib/README.md
new file mode 100644
index 0000000..7ca97b2
--- /dev/null
+++ b/display_lib/README.md
@@ -0,0 +1,11 @@
+# Dislpay Lib
+
+This library's purpose is to ease creation of wallmounted nodes with a display on front side. For example, signs and clocks. Display can be dynamic and/or different for each node instance.
+
+**Limitations**: This lib uses entities to draw display. This means display has to be vertical. So display nodes are only wallmounted vertically.
+
+**Dependancies**:default
+
+**License**: WTFPL
+
+**API**: See API.md document please.