started docs

LICENSE

@@ -0,0 +1,16 @@
+Copyright 2018 Chapel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
+associated documentation files (the "Software"), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial 
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/config.md

@@ -0,0 +1 @@
+## Configuration Options

docs/css-ref.md

@@ -0,0 +1 @@
+## CSS Selectors Reference

docs/customization.md

@@ -0,0 +1 @@
+## Using Custom Components

docs/installation.md

@@ -0,0 +1 @@
+## Installation Guide

docs/js-api.md

@@ -0,0 +1 @@
+## JavaScript API

docs/macros.md

@@ -0,0 +1 @@
+## Macros

docs/passages.md

@@ -0,0 +1 @@
+## Character Passages

docs/usage.md

@@ -0,0 +1 @@
+## Usage Guide

readme.md

@@ -0,0 +1,38 @@
+Noble avatars is a drop-in character portrait generator for the SugarCube 2 story format of Twine. If there's interest, I may port it to Harlowe v2.x in the future. Noble avatars is built using resources that were generously open-sourced by X. All the code was written from the ground up in JavaScript to work with SugarCube. 
+
+## Downloads
+Coming soon.
+
+## Documentation
+* [Installation guide](docs/installation.md)
+* [Usage guide](docs/usage.md)
+* [Configuration options](docs/config.md)
+* [Macros](docs/macros.md)
+* [Character passages](docs/passages.md)
+* [JavaScript API](docs/js-api.md)
+* [CSS selectors reference](docs/css-ref.md)
+* [Using custom components](docs/customization.md)
+
+## Features
+* Allows for player-controlled custom character creation out of the box, using a simple macro. 
+* Portraits can be made clickable and used like <<link>> macros for things like initiating conversations or seeing character descriptions. 
+* Can be used to generate random and predefined character portraits for all your character-generating needs, using a simple, passage and macro-based API. 
+* 15 trillion + combinations (supposedly, didn't do the math myself). 
+* Includes a bevy of customization options and configuration settings. 
+* A fairly complete JavaScript API and CSS selectors reference for tailoring the system to your needs. 
+* Includes an optional preloader for the image assets to ensure good performance. 
+* Simple to install and use. 
+
+### Some things that aren't supported (at least right now).
+* This was designed to use SugarCube, so does not work as a general-use JavaScript library or Twine plug-in. 
+* Using custom assets is possible but would requires some finagling to get it right. Making that less complex will be a design goal for the future, assuming this library sees some use and it is requested. 
+* Unfortunately, Noble Avatars uses totally different assets for the base male and female options, meaning that gender selection is completely binary and required. 
+* Right now, there's no way to tag certain creation options (outside gender restrictions and required-ness, i.e. all characters require eyes), meaning character portraits that are generated randomly are completely random by default, though you can use the API to supply only certain options to certain randomized characters, but this is labor-intensive. 
+
+## Legal info
+This code is licensed under MIT.  See the license for more.  In general, you must provide attribution to me (Chapel) in addition to including the info from the credits section somewhere in your game, like an about page.  It does not need to be particularly prominent. Please avoid implying that any of the individuals, myself included, directly worked on or endorsed your project.
+
+## Credits
+[Avatar graphics created by Noble Master Games](http://www.noblemaster.com)
+[Avatar graphics designed by Mei-Li Nieuwland](http://liea.deviantart.com)
+Noble Avatar Graphics licensed under [CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/legalcode)