doc discussion - Githubissues

YuHsiangHSU commented 8 years ago

Doxyfile：Doxygen 的設定檔，Doxygen 是一套 documentation system，看Doxyfile也需要看Doxygen (洋蔥領走)
README.md：開始的東西 (@iblis17 領走)
README_osx.txt：給MAC的
README_windows.txt：給windows的
REST-interface.md：REST API (@HuaYang-Chang 領走)
assets-attribution.md：[doc] Merge doc/assets-attribution.md into contrib/debian/copyright
benchmarking.md：各種SHA阿什麼的基準
bips.md：更新BIPs list
bitcoin_logo_doxygen.png：完整LOGO?
build-openbsd.md：for openbsd
build-osx.md：for mac
build-unix.md：for unix
build-windows.md：for windows
developer-notes.md：開發者的東西
dnsseed-policy.md：DNS什麼的
files.md：一些檔案
gitian-building.md：Setup instructions for a Gitian build of Bitcoin using a Debian VM or physical system.
init.md：Sample init scripts and service configuration for bitcoind
multiwallet-qt.md：錢包
reduce-traffic.md：好像跟幫助挖礦有關
release-notes.md：一些release前的note,各種更動 (@mchliu 領走)
release-process.md：好像是for maintainer跟builder
shared-libraries.md：一些lib
tor.md：tor support in bitcoin
translation_process.md：好像是教怎麼換語言寫
translation_strings_policy.md：上面的一些policy
travis-ci.txt：support for travis-ci
unit-tests.md：跑測試
zmq.md：Block and Transaction Broadcasting With ZeroMQ

iblislin commented 8 years ago

關於 Doxyfile，這應該是 Doxygen 的設定檔。 Doxygen 是一套 documentation system，如 python 上的 sphinx ， cpp 則有 Doxygen。

不過我沒用過 😝 ，誰要 survey 一下，看一下 Doxygen 的說明書，教大家產生出 doc

iblislin commented 8 years ago

@YuHsiangHSU 請更新原文中的說明。

YuHsiangHSU commented 8 years ago

@iblis17 是指說將剛剛你說明的文字更新到原本我PO的文件中嗎? 還是指文件中的敘述需要做改善呢?

iblislin commented 8 years ago

@YuHsiangHSU 用你的話改一下這篇PO文的敘述就好，畢竟這是份目錄，看得懂就好

YuHsiangHSU commented 8 years ago

@iblis17 OK! 那我順便領走Doxyfile，試著看看，然後也去看一下Doxygen，謝謝峻頤

iblislin commented 8 years ago

我先翻 README.md 好了

hychang23 commented 8 years ago

我先領 REST-interface.md 去看

iblislin commented 8 years ago

@HuaYang-Chang 那麼這個的先備知識有 REST API, wiki 有條目。到時候也麻煩向大家大致介紹一下。

hychang23 commented 8 years ago

ok

mchliu commented 8 years ago

那我領走developer-notes.md囉

iblislin commented 8 years ago

@YuHsiangHSU 那麼麻煩更新ㄧ下 po 文，標注誰拿走了啥

YuHsiangHSU commented 8 years ago

@iblis17 收到!!

mchliu commented 8 years ago

@iblis17 俊儀我領到一篇我發現都是在規範開發者格式的我可以把它扔一邊領另一篇吧哈剛好鈺享也打錯我就翻release-notes.md囉

iblislin commented 8 years ago

@mchliu ok, feel free

mchliu commented 8 years ago

好像有點少再領個benchmarking.md翻譯順便理解下

mwtsai commented 8 years ago

我嘗試用 https://bitcointalk.org/index.php?topic=149479.0 的教學 compile Bitcoin 0.9.4，卡在第3步驟make時， collect2 exe error ld returned 1 exit status 錯誤，我找不到解法，有沒人來解救一下。

iblislin commented 8 years ago

@mwtsai 這個 compilation 的問題，我們可以開個新 issue 來討論，因為這個問題與這篇討論串的主題無關。

我不能理解的是為何要去看一個比較舊而且非官方的文件？

目前 bitcoin 已經到 v0.12.1 了
官方有文件、不是沒有， https://github.com/APCLab/bitcoin/blob/master/doc/build-unix.md

可以說服我為何要看那份文件嗎？

hychang23 commented 8 years ago

@iblis17 我們可以跟你約星期四seminar時間跟你討論一下後續嗎?

iblislin commented 8 years ago

@HuaYang-Chang ok，那麼我考完試就過去管二

hychang23 commented 8 years ago

再領一個 build-openbsd.md

iblislin commented 8 years ago

https://dev.visucore.com/bitcoin/doxygen/

APCLab / bitcoin

doc discussion #5