Guidedog बिल्ड और इंस्टॉल करना¶
macOS पर Homebrew से स्थापित करें¶
Apple silicon या Intel वाले Mac पर आधिकारिक tap insanai/homebrew-guidedog का उपयोग करें:
brew tap insanai/guidedog
brew install insanai/guidedog/guidedog
guidedog --version
Homebrew आपके प्रोसेसर के लिए सही रिलीज़ पैकेज चुनता है और उसका SHA-256 जाँचता है। पैकेज में Typst, Graphviz और tree-sitter शामिल हैं। HTML और PDF बनाने के लिए Odin कंपाइलर, Python वातावरण या अलग से Typst स्थापित करने की ज़रूरत नहीं है। इस रिलीज़ के लिए macOS 12 या उससे नया संस्करण चाहिए।
अपना पहला प्रोजेक्ट आपकी पहली परियोजना के अनुसार बनाएँ। स्थापित रिलीज़ को अपडेट करने के लिए:
brew update
brew upgrade insanai/guidedog/guidedog
स्थापित पैकेज की जाँच के लिए brew test insanai/guidedog/guidedog चलाएँ। यह एक प्रोजेक्ट बनाकर उसका HTML और PDF तैयार करता है।
स्रोत से बिल्ड करें¶
tools/odin-release.txt में तय किया गया Odin टूलचेन इस्तेमाल करें। रिलीज़ में Odin dev-2026-10 और Typst 0.15.1 का उपयोग होता है। साझा लाइब्रेरी वाले बिल्ड के लिए Graphviz की डेवलपमेंट लाइब्रेरी चाहिए।
डेवलपमेंट बिल्ड¶
रिपॉज़िटरी के रूट से:
mkdir -p build
native/tree-sitter/build.sh
odin build cmd/guidedog -out:build/guidedog -o:speed -vet -strict-style
build/guidedog --version
build/guidedog formats
tree-sitter बिल्ड सोर्स-आधारित autodoc के लिए निश्चित संस्करण का Python व्याकरण देता है। Graphviz की विकास फ़ाइलें सिस्टम पैकेज मैनेजर से स्थापित करें। Typst ब्रिज के बिना बिल्ड PDF के लिए स्थापित typst चलाता है। उसे स्पष्ट चुनने के लिए --typst=/absolute/path/to/typst दें।
एम्बेडेड कम्पाइलर¶
नेटिव निर्भरताएँ एक बार बिल्ड करें, फिर Odin प्रोग्राम से लिंक करें:
cargo build --release --manifest-path native/typst_bridge/Cargo.toml
native/graphviz/build.sh
odin build cmd/guidedog -out:build/guidedog -o:speed \
-define:GUIDEDOG_TYPST_BRIDGE=true -define:GRAPHDOG_STATIC=true
Typst ब्रिज Rust में है और Guidedoc की आवंटन-मुक्त सीमा के बाहर है। एम्बेडेड बिल्ड अलग Typst प्रोग्राम चलाने की ज़रूरत हटाता है, लेकिन कंपाइलर का अपना मेमोरी खर्च नहीं।
Windows पर आउटपुट का नाम build/guidedog.exe रखें। बिना पथ दिए guidedog चलाने के लिए प्रोग्राम को PATH में रखें।