From f233d1d1426e755fb20d48546eaf9d597dd4b201 Mon Sep 17 00:00:00 2001 From: Atsushi Watanabe Date: Wed, 7 Dec 2016 11:00:45 +0900 Subject: [PATCH] updates readme (#24) * updates README and LICENSE files * fixes #23. --- COPYING | 35 ---------------------------------- LICENSE | 45 ++++++++++++++++++++++++++++++++++++++++++++ README | 56 ------------------------------------------------------- README.md | 20 ++++++++++++++++++++ 4 files changed, 65 insertions(+), 91 deletions(-) delete mode 100644 COPYING create mode 100644 LICENSE delete mode 100644 README create mode 100644 README.md diff --git a/COPYING b/COPYING deleted file mode 100644 index 2f155f4..0000000 --- a/COPYING +++ /dev/null @@ -1,35 +0,0 @@ -YamabicoProject-Spur (YP-Spur) is A is developed with Intelligent Robot Laboratory based on SH-Spur. - -ACCESS to -URL: http://www.roboken.esys.tsukuba.ac.jp/ -E-mail: platform2010@roboken.esys.tsukuba.ac.jp - ----------------------------------------------------------------------------- -The SH-Spur source code is available under the MIT License, see -http://www.opensource.org/licenses/mit-license.html - -ACCESS to -URL: http://sourceforge.jp/projects/pc-ymbc/ -E-mail: etake@users.sourceforge.jp - - ----------------------------------------------------------------------------- -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/LICENSE b/LICENSE new file mode 100644 index 0000000..8351c79 --- /dev/null +++ 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 deleted file mode 100644 index 61d1e1a..0000000 --- a/README +++ /dev/null @@ -1,56 +0,0 @@ -YP-Spur -Yamabico Project - Spur - -ISS のプログラムをベースにTKUに開発されたSH-Spurをもとに開発 - -以下は ISS の引き継ぎ資料。 - -//////////////////////////////////////////////////////////// - SH2を用いて実験を行った際のプログラム、実験データ集 - 2007.3.21 ISS -//////////////////////////////////////////////////////////// - -○データ、プログラム内容 -・main.c ： メイン関数 -・sh7040s.h ： アドレス定義 -・sh_7045.h ： SCI,CMTに関するの関数群 -・define.h ： 定数の定義、グローバル変数の宣言 -・isincos.h ： sin,cosの計算をテーブル参照で計算するための関数郡 -・isincos/ ： 上記を行うために使用したプログラム -・isintable.h ： 0〜90°までの32768倍されたsinのテーブル - 360°を65536としている。 -・motor_control.h ： モータ回転数制御をするための関数郡 -・odometry.h ： オドメトリをとるための関数郡 -・following.h ： 経路追従、目標点移動をするための関数郡 -・demo.h ： デモ用関数 -・SCI.h ： シリアル通信をするための関数郡 - - -・sh7045rom.x ： リンカスクリプト - 機械語のプログラムやデータの配置 - （どこのアドレスに配置するか）を決める。 - DTCの定義はこの辺で行っている。 -・startup.s ： スタートアップルーチン - 外付けカウンタの設定をここで行う。 - - -・sh2.mot ： SH2へ書き込む実行ファイル -・put_data/ ： ロボット１〜４に書き込むそれぞれの実行ファイル - - -・test/　　　　　 ： デバッグのためのプログラム - counter.mot ： ４チャンネルのエンコーダカウンタ値を表示 - pwmtest.mot　 ： ４チャンネルのモータに0〜1000のPWM比を与える - sciout.mot　　： シリアル通信の確認、勉強用 - -・sh7045writer　　： SH2にmotファイルを書き込むコマンド - - -○開発環境 -秋月 SH2/7045F ボードに付属のCDよりインストール。 - sh-coff-gcc - sh-coff-objcopy -（かそれと同等なもの）が使えるようになれば大丈夫なはず。 - -書き込みは同CDに h8write が入っているが、sh7045writer を用いた方が断然早い。 - diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b08963 --- /dev/null +++ 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/).