diff --git a/doc/README.ja.md b/README.ja.md similarity index 94% rename from doc/README.ja.md rename to README.ja.md index e2171c6..1798bc9 100644 --- a/doc/README.ja.md +++ b/README.ja.md @@ -1,4 +1,6 @@ # StackShot3X API for Python +[**English**](./README.md) + StackShot3Xを操作するためのPython用API @@ -133,3 +135,7 @@ StackShot3Xに対する挙動を表す列挙型 ## class RailUnits レールを動かす距離の単位を表す列挙型 + + +# 謝辞 +本ソフトウエアは 日本学術振興会 科学研究費 基盤研究B 22H03710の助成を受けて開発されました。 \ No newline at end of file diff --git a/doc/README.en.md b/README.md similarity index 82% rename from doc/README.en.md rename to README.md index 3b07534..ab5d2e5 100644 --- a/doc/README.en.md +++ b/README.md @@ -1,4 +1,6 @@ # StackShot3X API for Python +[**日本語**](./README.ja.md) + API to controll StackShot3X on Python @@ -103,34 +105,38 @@ The following is an implementation based on [this](https://www.cognisys-inc.com/ ## class RailStatus -特定の軸におけるレールの状態を表す列挙型 +Enum class representing the status of the rail on a particular axis ## class StackShotStatus -StackShot3Xの状態を表す列挙型 +Enum class representing the status of StackShot3X ## class RailAxis -StackShot3Xのレールの軸を表す列挙型 +Enum class representing the axis of a StackShot3X rail ## class Cmd -StackShot3Xにおける各コマンドを表す列挙型 +Enum class representing each command in StackShot3X ## class Action -StackShot3Xに対する挙動を表す列挙型 +Enum class representing actions for StackShot3X ## class RailDir -レール上の進行方向を表す列挙型 +Enum class representing directions of travel on the rail ## class RailUnits -レールを動かす距離の単位を表す列挙型 +Enum class representing units of distance to move the rail + + +# Acknowledgements +This software was supported by JSPS Grant-in-Aid for Scientific Research (B)22H03710. \ No newline at end of file diff --git a/doc/images/step1.png b/images/step1.png similarity index 100% rename from doc/images/step1.png rename to images/step1.png diff --git a/doc/images/step2.png b/images/step2.png similarity index 100% rename from doc/images/step2.png rename to images/step2.png diff --git a/doc/images/step3.png b/images/step3.png similarity index 100% rename from doc/images/step3.png rename to images/step3.png