updates readme (#24)

* updates README and LICENSE files * fixes #23.
openspur · Dec 7, 2016 · f233d1d · f233d1d
1 parent 72ce5f2
commit f233d1d
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 91 deletions.
diff --git a/COPYING b/COPYING
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,45 @@
+MIT License
+
+Copyright (c) 2010-2016 The YP-Spur Authors, except where otherwise indicated.
+
+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.
+
+
+YP-Spur has been forked from SH-Spur. The original SH-Spur source code is:
+
+Copyright (c) 2008 Eijiro Takeuchi and Intelligent Robot Laboratory Univ. of Tsukuba, All rights reserved.
+
+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.
+
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# YP-Spur (YamabicoProject-Spur)
+
+## Purpose
+
+YP-Spur is a mobile robot motion control software with coordinate frame based commands. 
+
+## Getting Started
+
+Learn to use YP-Spur at our [wiki pages](https://github.com/openspur/yp-spur/wiki).
+
+## License
+
+* YP-Spur is available under the [MIT License](http://www.opensource.org/licenses/mit-license.html).
+    * Copyright (c) 2010-2016 The YP-Spur Authors, except where otherwise indicated.
+* YP-Spur has been forked from SH-Spur. The original [SH-Spur source code](http://sourceforge.jp/projects/pc-ymbc/) is available under the [MIT License](http://www.opensource.org/licenses/mit-license.html).
+    * Copyright (c) 2008 Eijiro Takeuchi and Intelligent Robot Laboratory Univ. of  Tsukuba, All rights reserved.
+
+## Contributing
+
+Please post issues and/or pull-requests on our [GitHub repository](https://github.com/openspur/yp-spur/).