README for development

要件

ビルド

readme.md をつくる:

$ python build.py

インプットは以下のとおり:

<readme_header.md の内容>
<パースした md ファイルからつくった目次>
<readme_footer.md の内容>

運用

記事を追加する

n.bat を実行する。

ファイル名を入力すると、現在日付ベースで yyyy/mm/(YourFileName).md が作成され、オープンされる。

オープンは「md ファイルに関連付けられたアプリ」で開く。

ビルド(書いた記事の目次化)、アップロード

b.bat を実行する。

build.py が走った後、commit と push も走る(コミットメッセージは都度入力だが適当で良い)。

ただし commit と push については upload.bat を使用

FAQ

q: インボックス(inbox)とは?

インボックスとは「気になることなどをとりあえず置いておく場所」。未処理を溜めるエリア。

すぐに n.bat でファイル名が思い浮かばない場合は、inbox.md に溜める。

q: なぜ b.bat で毎回 .md 拡張子を入力させる?

手間を考えれば .md は自動入力させるのが良いが、私の癖でファイル名につい .md と書いてしまう(結果 .md.md になってしまう :smirk:)ので、あえて自動入力させてない。