作者DoraBoy (小多啦)
看板EE_DSnP
標題[問題] 關於README 和 Written Report
時間Wed Jan 23 17:02:40 2008
請問大家一下
README 是要做啥的阿??
是要寫說要怎麼compile這些檔案嗎
(例如:先打開src資料夾 再點選project file 執行 加complie就ok了)
還是要寫說 程式中的xxx指令是什麼 教使用者如何使用 並附上一些例子嗎?
那README跟Written Report 有什麼不同呢
(README是介紹如何使用?? , Written Report是跟教授解釋程式到底在寫什麼嗎??)
實在不太清楚... (怕寫錯就囧了...)
請大家幫幫忙吧
謝謝囉
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 218.174.89.107
1F:推 keyboardle:README應該是解釋資料夾內有哪些檔案.以及自己的程式支 01/23 20:31
2F:→ keyboardle:援哪些功能吧.比較簡介.written report就要解釋程式的 01/23 20:32
3F:→ keyboardle:結構.演算法等等的了吧.然後可使用的測試方法等詳細資 01/23 20:32
4F:→ keyboardle:料吧我想... 01/23 20:33
5F:推 ilway25:User manual 是不是要寫得像手機說明書一樣 = = 01/23 20:54
6F:→ k60202:需要說明演算法嗎?可是我的程式碼一貼上去就超過最高上限 01/23 22:17
7F:→ k60202:的一半......如果把程式碼切割好像也很奇怪...... 01/23 22:19
8F:→ k60202:個人覺得自己寫的報告根本就是說明書...... 01/23 22:20