項目的自述文檔（README）模闆

翻譯自 @PurpleBooth 的 README 模闆

項目标題

使用一段話簡要描述項目内容。

獲得開始

這些說明将為您提供一個在你的個人本地計算機上啟動和運作的項目副本，以便進行開發和測試。有關如何在實時系統上部署項目的細節，請參閱部署。

先決條件

需要安裝什麼軟體以及如何安裝它們。

給一些例子           

安裝使用

提供一些例子說明你是如何部署運作的環境的。

表述部署的步驟是什麼，并給出示例：

給出示例           

最後，以一個小 demo 結束：從外部擷取資料，并使用部署好的環境展示項目。

運作測試程式

解釋如何提供這個系統的自動化測試。

分解為端到端測試

解釋測試的内容以及原因。

給出示例           

編碼樣式測試

給出示例           

部署

添加有關如何在實時系統部署此項的其他說明。

内置

• 使用的架構，如 Dropwizard 。
• 依賴項管理，如 Maven
• 用于生成 RSS 源，如 ROME

投稿

請閱讀

CONTRIBUTING.md

，了解我們的行為準則以及如何向我們送出拉取請求的過程。

版本

我們使用

https://semver.org/lang/zh-CN/

進行版本控制。有關可用的版本，請:book:

此存儲庫中的标記

作者

• Billie Thompson - Initial work - PurpleBooth

另請參閱參與此項目的

貢獻者

清單。

許可證

此項目根據 MIT 許可證獲得許可 - 有關詳細資訊，請參閱

LICENSE.md

檔案。

緻謝

• 感謝所有使用本項目的人
• 激勵
• etc