diff --git a/README.md b/README.md index 7645117..d46cf17 100644 --- a/README.md +++ b/README.md @@ -15,24 +15,7 @@ It is expressly built with our Redacted3D engine in mind, but steps have been ta JUI provides a set of objects that we term Widgets, which can be styled and laid out on-screen in relation to each other. Each widget has a single parent, and a list of child elements. Your root widget should be a Scene object. ## Features -* Comprehensive list of common UI widgets: - * ![Scene](https://git.redacted.cc/josh/ReJUI/wiki/Scene) - * ![Rect](https://git.redacted.cc/josh/ReJUI/wiki/Rect) - * ![Text](https://git.redacted.cc/josh/ReJUI/wiki/Text) - * ![TextRect](https://git.redacted.cc/josh/ReJUI/wiki/TextRect) - * ![Button](https://git.redacted.cc/josh/ReJUI/wiki/Button) - * ![TextButton](https://git.redacted.cc/josh/ReJUI/wiki/TextButton) - * ![TextInputForm](https://git.redacted.cc/josh/ReJUI/wiki/TextInputForm) - * ![Slider](https://git.redacted.cc/josh/ReJUI/wiki/Slider) - * ![Image](https://git.redacted.cc/josh/ReJUI/wiki/Image) - * ![ImageRect](https://git.redacted.cc/josh/ReJUI/wiki/ImageRect) - * ![RadioButton](https://git.redacted.cc/josh/ReJUI/wiki/RadioButton) - * ![Window](https://git.redacted.cc/josh/ReJUI/wiki/Window) - * ![Checkbox](https://git.redacted.cc/josh/ReJUI/wiki/Checkbox) - * ![NineSliceRect](https://git.redacted.cc/josh/ReJUI/wiki/NineSliceRect) - * Vertical and Horizontal ListLayout, GridLayout - * Separator - * ScrollRect +* Flexible and comprehensive set of Widgets. [Full List Here](docs/widgets.md) * Extendable - Widgets can be extended via class derivation, and even combined to create complex behavior. * Low-overhead stateful GUI elements. * Easy integration with your project. Simply provide update, draw, and user-input callbacks to your scene. @@ -58,6 +41,10 @@ Currently, the package is also integrated with ![J3ML](https://git.redacted.cc/j Documentation is automatically generated from latest commit and is hosted at https://doc.redacted.cc/jui . +[An overview of the library is available here.](docs/overview.md) + +[A full list of widgets is available here.](docs/widgets.md) + ## Contributing Contributions to JUI are welcome! Feel free to file bug reports or feature requests by creating an Issue. Pull requests are also very welcome! diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/widgets.md b/docs/widgets.md new file mode 100644 index 0000000..a01cc50 --- /dev/null +++ b/docs/widgets.md @@ -0,0 +1,43 @@ +
+Widget +This is some information about the Widget class. +
+ + +
+BindMenu +This is some information about the Widget class. +
+ +
+Button +This is some information about the Widget class. +
+ + +
Checkbox +This is some information about the Widget class. +
+ + +
Collapsible +This is some information about the Widget class. +
+ +
ColorPicker +This is some information about the Widget class. +
+ +
ComboBox +This is some information about the Widget class. +
+ +
CommandLine +This is some information about the Widget class. +
+ +
ContextMenu +This is some information about the Widget class. +
+ +