Update readme with project details, add license and test status files

Author: EliJDonahue

LICENSE.md

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Aras Corporation
+
+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.

README.md

@@ -1 +1,81 @@
-CustomTechDocs
+# CustomTechDocs
+
+Demonstrates how to create a custom content generator for Tech Doc schema elements.
+
+## Project Details
+
+See [TESTSTATUS file](./TESTSTATUS.md) for latest testing information.
+
+#### Built Using:
+Aras 11.0 SP9
+
+#### Versions Tested:
+Aras 11.0 SP9 (open release)
+
+#### Browsers Tested:
+Firefox 38 ESR
+
+> Though built and tested using Aras 11.0 SP9, this project should function in older releases of Aras 11.0.
+
+## How It Works
+The project's import package adds a new content generator method for the ItemInfo schema element, replacing the out-of-the-box implementation. The new content generator method, `labs_ItemInfoContentGenerator`, populates every new ItemInfo element with the name, description, cost, major revision/generation, state, and created date for the selected assembly (Part item). The method also adds the assembly's BOM in a tabular layout.
+
+## Installation
+
+#### Important!
+**Always back up your code tree and database before applying an import package or code tree patch!**
+
+### Pre-requisites
+
+1. Aras Innovator installed (version 11.0 SPx preferred)
+2. Aras Technical Documentation is installed
+3. Aras Package Import tool
+4. CustomTechDocs import package
+
+### Install Steps
+
+1. Backup your database and store the BAK file in a safe place.
+2. Open up the Aras Package Import tool.
+3. Enter your login credentials and click **Login**
+  * _Note: You must login as root for the package import to succeed!_
+4. Enter the package name in the TargetRelease field.
+  * Optional: Enter a description in the Description field.
+5. Enter the path to your local `..\CustomTechDocs\Import\imports.mf` file in the Manifest File field.
+6. Select the following in the Available for Import field.
+  * **aras.labs.CustomTechDocs**
+  * **com.aras.innovator.solution.TechDoc**
+  * **com.aras.innovator.tdf**
+  * **com.aras.innovator.solution.PLM**
+7. Select Type = **Merge** and Mode = **Thorough Mode**.
+8. Click **Import** in the top left corner.
+9. Close the Aras Package Import tool.
+
+You are now ready to login to Aras and try out the CustomTechDocs project.
+
+## Usage
+
+**Pre-requisite:** The Aras instance should include some Parts with BOM relationships.
+
+1. Log in to Aras as admin.
+2. Navigate to **Technical Documentation > Technical Documents**.
+3. Create a new Technical Document with the `Standard` schema.
+4. Add an ItemInfo element to the document, selecting a Part with Part BOM relationships when the search dialog appears.
+5. Save the document.
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request
+
+For more information on contributing to this project, another Aras Labs project, or any Aras Community project, shoot us an email at [email protected].
+
+## Credits
+
+Created by Eli Donahue for Aras Labs. @EliJDonahue
+
+## License
+
+Aras Labs projects are published to Github under the MIT license. See the [LICENSE file](./LICENSE.md) for license rights and limitations.

TESTSTATUS.md

@@ -0,0 +1,15 @@
+# Test Status
+
+Indicates the result of the latest testing. Projects are tested in the version they were developed, as well as the last open release of Aras Innovator.
+
+### Key
+  * :heavy_check_mark: - passed testing
+  * :heavy_exclamation_mark: - minor issues in testing
+  * :x: - project not recommended for browser/version
+  * :heavy_minus_sign: - unsupported browser
+
+### Results
+
+            | IE 11      | FF 38 ESR  | Chrome     
+------------|------------|------------|------------
+Aras 11 SP9 |  | :heavy_check_mark: |