Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Study] 調整 readme #8

Closed
chen-tf opened this issue Dec 4, 2022 · 2 comments · Fixed by #30
Closed

[Study] 調整 readme #8

chen-tf opened this issue Dec 4, 2022 · 2 comments · Fixed by #30
Assignees

Comments

@chen-tf
Copy link
Owner

chen-tf commented Dec 4, 2022

身為 對這個專案有興趣的開發者
我希望 專案有清楚的 readme
如此 才可以快速地了解這個專案的背景

背景

目前的 readme 比較像是一個故事書...,需要思考一下該做一些什麼調整,讓未來想要 fork project 的人能快速地進入狀態。

Definition of Done

  1. 如何執行這個專案
  2. 想要擴充功能要從何進行
  3. 實際上支援幾種指令
@chen-tf chen-tf changed the title [Study] [Study] 調整 readme Dec 4, 2022
@hokou
Copy link
Contributor

hokou commented Dec 5, 2022

我的問題是後續會重新調整架構
先以目前架構來調整版面嗎?

目前是想 readme 裡面大概有

  1. 更新項目
  2. 功能介紹(user)
  3. 如何執行(developer)
  4. 相關功能的連結 md

然後有一個資料夾專門擺放相關文件.md

@hokou hokou self-assigned this Dec 5, 2022
@chen-tf
Copy link
Owner Author

chen-tf commented Dec 5, 2022

如果是資料夾專門放一些 .md 的話,也可以挪到 GitHub Wiki 上面集中管理

@hokou hokou linked a pull request Dec 12, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants