LoginSignup
0
0

More than 3 years have passed since last update.

Org-mode based development

Last updated at Posted at 2020-11-20

Gitでこまめにcommitした方がいいのがわかってはいるけれど、
うまくcommitできないというかいちいちどうメッセージを打てばいいか分からなくなる
一方で、研究資料含めてorg-mode(+beamer export)でまとめる癖がついていたので、
README.mdをorg-modeで書いてみることに。
そういえば実験結果も一緒にcommitして仕舞えば後で見返せるな...

研究室サーバーにtrampでログインしておいて、
README.orgファイルに次の実装計画などを追加していく。
プログラム開発用にはVSCodeを使っているので(以前はPyCharmだったけど、機能が多すぎて重たいと感じていたので移行した)
ある程度まで書いたりTODOのタスクが一つ終了するたびにcommitして、
尚且つREADME.orgに記載していたタスクをsubtreeごとコピペしてcommit(magit)する
そうすると、メモをgit logに関連して見直せるし便利。
また、文章をいちいち書くのめんどくさくてcommitしていなかったという問題も解消される。

プログラムコードとして残る変更はいいんだけど、
環境構築系の後から見直してこれどうしたんだっけみたいなものも、
org-modeの方に参考にしたサイトとかのメモを取っておけば自然と問題が解消されるし、
README.org ファイルを変更したことを検出してくれるから、
自然とプロジェクトの進捗の段階に応じてcommitできる。

...magit便利...

magit+org-mode+org-beamer-export

作業記録をorg-modeで取った後、beamerを使ってスライドにまとめる。
作業記録それ自体が残っていると、viewが飛んだりして非常に扱いづらいから、
magitからgit showをして、過去のファイル(作業履歴)を見返しつつ、
話の流れそれ自体は独立にまとめるというか綺麗なファイルに一から記載して行った方がわかりやすいスライドになりがち。
gitに保存されているので、過去の作業記録も過去のスライドも躊躇なく消せるのが素晴らしい...
c.f. https://qiita.com/eggc/items/948f8df70069334e8296

Future Work

Org-modeのsubtreeみたいに、編集履歴というかcommitのlogもツリー上にする方法ないのかな...
いちいちbranch作るのは面倒だし...
logで見返すときだけでいいんだろうけど

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0