tamada/ttt repository overview

⁠ttt

このツールは，KSU ISEにおける各コースの終了要件を単位取得科目から確認するためのツールです． ttt は「単位をたくさん取ろう」の頭文字です．

なお，このツールを使った事による不利益は，いかなる場合であっても一切保証しません．

⁠使い方

credits.json を準備し，次のようにコマンドを実行してください．

$ ttt credits.json

⁠credits.json

今まで単位を取得した科目を列挙したJSONファイルです． 文字列の配列として科目を列挙してください．

具体的には，次のように単位取得科目を書いていってください．

[
    "ソフトウェア工学I",
    "基礎プログラミング演習I",
    "基礎プログラミング演習II",
    "発展プログラミング演習",
]

⁠Help

$ ttt --help
ttt バージョン 1.0.0
ttt [OPTIONS] <CREDITS.JSON...>
OPTIONS
    -c, --course=<COURSE>    特定のコースのみの判定を行う．部分一致．
                             指定されない場合は全コースで判定を行う．
    -e, --on-error=<TYPE>    エラー時の挙動を設定する．デフォルトは WARN（エラーを表示して続行）．
                             有効値は IGNORE（エラーを無視），WARN，QUIT（エラーを表示して終了）．
    -y, --year=<YEAR>        入学年を指定する．デフォルトは 2018．
    -v, --verbose            冗長出力モード．デフォルトはOFF．
    -h, --help               このメッセージを表示する．
ARGUMENTS
    CREDITS.JSON             単位を取得した講義を列挙したJSONファイル．複数指定可能．

⁠Web上での実行

Webページ⁠から，Web上で判定できます．

⁠ブラウザ対応状況

• Safari 未対応 :worried:
• Google Chrome OK :smile:
• Edge たぶんOK :simple_smile:
• Firefox たぶんOK :simple_smile:

⁠Docker を使った実行

$ docker run --rm -v "$PWD"/home/ttt tamada/ttt:1.0.0 credits.json

credits.json のあるディレクトリで実行してください． なお，docker のオプション，引数の意味は次の通りです．

• --rm
  • Docker終了後，コンテナは自動的に削除される．
• -v "$PWD":/home/ttt
  • ホストOSの$PWD（現在のディレクトリ）を，コンテナOSの/home/tttに割り当てる．
  • コンテナOSでは，/home/tttでtttが実行される（tttユーザにて実行される）．
• tamada/ttt:1.0.0
  • Docker Hub⁠で配布されているDockerfileを特定するためのID．
  • tamadaがtttという名前でバージョン1.0.0として配布しているDockerfileを利用する．
• credits.json
  • ホストOSにある $PWD/credits.json を ttt の引数に与える．

⁠判定方法

dataディレクトリに，lectures.jsonとcourses.jsonが含まれています． lectures.jsonが科目一覧で，科目ごとの科目名，配当学年，単位数が記録されています． courses.jsonはコース一覧を表しています． 詳細は，data フォルダをご覧ください．

⁠インストール方法

⁠Homebrew

$ brew tap tamada/brew
$ brew install ttt

⁠Docker

Dockerを使った実行⁠を参照のこと．

⁠Go lang

$ go get github.com/tamada/ttt

⁠手作業でインストール（バイナリインストール）

• Releaseページ⁠から適切なバージョン，OS，アーキテクチャのファイルをダウンロードする．
• ダウンロードした tar.gz ファイルを慎重する．
• 適切な場所にインストールする．
  • dataディレクトリは/usr/local/share/ttt/data 以下にあるか，カレントディレクトリ以下にあることを前提としています．

⁠手作業でインストール（ソースからビルド）

• GitHubのページ⁠からリポジトリをクローンしてください．
  • git clone https://github.com/tamada/ttt
• 作成されたディレクトリに移動してください．
  • cd ttt
• makeを実行してください．
  • make
• カレントディレクトリに ttt というバイナリが作成されます．