Skip to content

Commit 097db8b

Browse files
znzclaude
andcommitted
Tutorial: fork の同期と古い ../bitclust についての注意を追加
チュートリアルどおりに進めても、(1) 以前の fork の master が古いまま、 (2) 過去に clone した古い bitclust が隣のディレクトリに残っている、の いずれかで分かりにくいエラーになる (rurema/bitclust#230)。 - fork の項に「Sync fork」で最新化してから進む手順を追加 - bundle install の項に、Gemfile が BITCLUST_PATH (既定値 ../bitclust) を 優先する仕組みと、古い場合の症状・対処を追加 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 81ad09f commit 097db8b

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

docs/Tutorial.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ https://github.com/rurema/doctree
3737

3838
"自分のアカウント名/doctree" というリポジトリが作られたことを確認してください。
3939

40+
なお、以前に fork したことがある場合は、自分の fork の master が
41+
rurema/doctree より古くなっています。fork のページの「Sync fork」ボタンで
42+
最新に同期してから先へ進んでください。
43+
4044
## 3. リポジトリを作業ディレクトリへと clone する
4145

4246
以下のコマンドを実行し、現在の開発環境にリポジトリをコピーしてください。
@@ -88,6 +92,14 @@ doctree リポジトリで `bundle install` すれば入ります。
8892
$ bundle install
8993
```
9094

95+
なお、doctree の `Gemfile` は、隣のディレクトリ(環境変数 `BITCLUST_PATH`
96+
既定値 `../bitclust`)に bitclust のチェックアウトが存在すると、そちらを
97+
優先して使います(bitclust 自体を開発する人向けの仕組みです)。過去に
98+
clone した古い bitclust が残っていると、`cannot load such file -- drb`
99+
`invalid option: --markdowntree` のようなエラーでビルドに失敗します。
100+
その場合は `../bitclust` を最新にする(`git pull`)か、削除してから
101+
`bundle install` をやり直してください。
102+
91103
typo の修正のような日本語の修正程度であれば以下を行わずとも pull request を送っていただいて問題ありません。
92104
[ReferenceManualFormatDigest](ReferenceManualFormatDigest.md) にあるような書式も修正の対象となる場合はプレビューで確認後に pull request を送っていただけるとありがたいです。
93105

0 commit comments

Comments
 (0)