根據 whitefloor 調整了既有的說明文檔

[y2468101216]

👏 解決掉的 issue / Resolved Issues

• close [主線] [PTT] 將 readme.md 調整對開發者更易上手的格式 #151

⛏ 變更內容 / Details of Changes

根據 whitefloor 調整了一些文檔上的問題

主要的更動如下:

1. 將歷史緣由跟開發原因搬進 FOR_DEVELOPERS.md 裡面

我覺得作為一個專案的門面，應當盡量簡單扼要說明這個專案的的功能。

2. 直接增加了如何參與這個專案

由於希望此專案不要變成一人開發，需要用更簡單的方法吸引人進來參與

3. 增加了 Q&A

我將 Q&A 拆成了兩個 part ，一個是給要深入專案的，一個是給第一次參與的

[codecov-commenter]

Codecov Report

Merging #200 (6d5d292) into development (0dc9641) will decrease coverage by 0.31%.
The diff coverage is n/a.

@@               Coverage Diff               @@
##           development     #200      +/-   ##
===============================================
- Coverage        45.20%   44.89%   -0.32%     
===============================================
  Files               25       25              
  Lines             1294     1321      +27     
===============================================
+ Hits               585      593       +8     
- Misses             623      641      +18     
- Partials            86       87       +1     

Impacted Files	Coverage Δ
internal/usecase/article.go	40.74% <0.00%> (-4.26%)	⬇️
internal/delivery/http/route_forward_article.go	68.51% <0.00%> (-1.66%)	⬇️
internal/delivery/http/route_users.go	49.17% <0.00%> (-1.63%)	⬇️
internal/delivery/http/route_boards_treasures.go	57.14% <0.00%> (-1.48%)	⬇️
internal/delivery/http/route_boards_articles.go	50.81% <0.00%> (-0.75%)	⬇️
internal/delivery/http/route_create_article.go	67.44% <0.00%> (-0.74%)	⬇️
internal/delivery/http/route_boards.go	56.00% <0.00%> (-0.58%)	⬇️
internal/repository/user.go	1.85% <0.00%> (-0.11%)	⬇️
internal/usecase/token.go	0.00% <0.00%> (ø)
internal/repository/board.go	0.00% <0.00%> (ø)
... and 5 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0dc9641...6d5d292. Read the comment docs.

[unknowntpo]

另外，我找到了一份關於中英交叉的 README 怎麼寫的 GitHub Repo ，給大家參考。

• sparanoid / chinese-copywriting-guidelines

還有，這份是關於 README 如何排版的指引。

• RichardLitt / standard-readme

[unknowntpo]

還有一小部分沒有改到。

[PichuChen]

LGTM

[y2468101216]

@unknowntpo 如果沒問題再麻煩妳看看

[unknowntpo]

剩下這些地方。