From aed1d3f87a69af7823f2e37af9fc19dde7a0d26a Mon Sep 17 00:00:00 2001
From: Kodai Okawa <okawa@cns.s.u-tokyo.ac.jp>
Date: Thu, 17 Feb 2022 14:51:41 +0000
Subject: [PATCH] Update README.md

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/README.md b/README.md
index b686af6..bcf0511 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,54 @@
 # ridf2root
+
+## 環境
+* ROOT v6.14 (ROOTSYSの設定が必要)
+    * (M1 Macには古いバージョンのROOTを入れることが出来なかった)
+* cmake 3.8
+* いくつかのパッケージ(wget, autoconf...)
+
+## 概要
+* ridf2root https://www.cns.s.u-tokyo.ac.jp/gitlab/shimiz/ridf2root
+* cordfer https://www.cns.s.u-tokyo.ac.jp/gitlab/shimiz/cordfer
+
+をもとに作成した。anarootのdecoderを用いてridfファイルをrootファイルにする。decoderの中身を少し変える必要がある（si26a）ため、anarootの中の環境を管理しやすいようにridf2rootのディレクトリ内に新しいanarootをインストールするようにした。
+
+## 使い方
+
+### 編集するファイル
+* recipe/***.yml
+* map/(exp_name)/***.map
+* main.cpp?
+
+### コマンド
+buildディレクトリを作って、その中でコンパイルする
+```console
+mkdir build
+cd build
+cmake ..
+source ../anaroot/setup.sh
+make
+```
+./CMakeLists.txt内でanarootをmake installするようにしているので、実質cmake ..でanarootをmake installしている。
+
+できた実行ファイルridf2rootはファイルを指定して変換する。（拡張子はなし）
+```console
+./ridf2root -i inputridf (-o outputroot)
+```
+
+cmakeやmakeに失敗したときは、buildファイルを消してやり直す。
+```console
+cd ..
+rm -rf build
+mkdir build
+cd build
+cmake ..
+source ../anaroot/setup.sh
+make
+```
+
+## 課題
+* mapファイルから読み取れるようにしているが、多少強引に読んでいる（anaroot内にもTArtMapのようなclassがあったが使い方がよくわからなかった）
+    * 汎用性が低い？
+* calibrationをどのように行うか（parameterファイルから読み取れるようにする->MUXはどうするか？）
+* anarootのライブラリをもっと活用できないか
+* mapファイルに従って、adcとtdcは一つのブランチにまとめて、チャンネルで区別するようにしたが使いやすいかどうか
-- 
GitLab