update: docs(main description)

This commit is contained in:
Wataru Otsubo 2024-09-14 02:26:32 +09:00
parent 98d246a054
commit 48e83bfe18
6 changed files with 468 additions and 19 deletions

View file

@ -0,0 +1,29 @@
```@meta
CurrentModule = PSBoardDataBase
```
# このリポジトリのソフトウェアについての説明
このリポジトリにあるのは、JATHub masterのログファイル、及びGoogle SheetsからエクスポートしたCSVファイルからデータベースを作成するためのコードである。
メインの関数は[`create_database_from_exported_csvs`](@ref)である。
## テストについて
テストでは実際にデータベースを作成している。
デフォルトでは全部は実行しないが、master log fileをおき、かつ環境変数`LOCAL_TEST`を設定することで、master log fileが必要な工程まで含めて実行できる。[^1]
[^1]: master log fileはgitには入れたくないので、このような形態をとっている。
## API
```@index
```
```@autodocs
Modules = [PSBoardDataBase]
```
### `QaqcMasterLog`
```@autodocs
Modules = [QaqcMasterLog]
```