add basic outline

Author: ccoffrin

CHANGELOG.md

@@ -0,0 +1,5 @@
+PGLib OPF Benchmarks Change Log 
+===============================
+
+### v19.08
+- Initial release

LICENSE

@@ -0,0 +1,31 @@
+Data License:
+
+Creative Commons Attribution 4.0 International license
+http://creativecommons.org/licenses/by/4.0/
+
+See data files for specific copyright holders and attribution details. 
+
+
+Software License:
+
+MIT License
+Copyright (c) 2017 A Library of IEEE PES Power Grid Benchmarks
+
+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,2 +1,28 @@
-# pglib-uc-dev
-Benchmarks for the Unit Commitment Problem
+# Power Grid Lib - Unit Commitment
+
+This benchmark library is curated and maintained by the [IEEE PES Task Force on Benchmarks for Validation of Emerging Power System Algorithms](https://power-grid-lib.github.io/) and is designed to evaluate a well established version of the the Unit Commitment problem.  Specifically, these cases are designed for benchmarking algorithms that solve the following the Mixed-Integer Linear Program described in the formulation [PDF document](tbd).
+
+A detailed description of this mathematical model is available [here](tbd).  All of the cases files are curated in a json-based data format.  Open-source reference implementations are available in [TBD](.) and [TBD](.).
+
+## Problem Overview
+
+Discuss high level features / scope of the model (e.g. ramp rates, up time ect.).
+
+
+## Case File Overview
+
+A brief discussion of where the datasets come form.
+
+
+## Contributions
+
+All case files are provided under a [Creative Commons Attribution License](http://creativecommons.org/licenses/by/4.0/), which allows anyone to share or adapt these cases as long as they give appropriate credit to the original author, provide a link to the license, and indicate if changes were made.
+
+Community-based recommendations and contributions are welcome and encouraged in all PGLib repositories. Please feel free to submit comments and questions in the [issue tracker](https://github.com/power-grid-lib/pglib-uc/issues).  Corrections and new network contributions are welcome via pull requests.  All data contributions are subject to a quality assurance review by the repository curator(s).
+
+
+## Citation Guidelines
+
+This repository is not static.  Consequently, it is critically important to indicate the version number when referencing this repository in scholarly work.
+
+Users of this these cases are encouraged to cite the original source documents mentioned in this overview document.