From 7a0420d8fa9c8b414d2efaa1f12e2bf4a308b598 Mon Sep 17 00:00:00 2001 From: ageerle <ageerle@163.com> Date: 星期五, 28 三月 2025 10:59:11 +0800 Subject: [PATCH] feat: 更新项目文档 --- README.md | 72 ++++++++++++++++++++++++------------ 1 files changed, 48 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 062b7b3..381cf45 100644 --- a/README.md +++ b/README.md @@ -158,44 +158,68 @@ ``` -### 浣跨敤鍒扮殑妗嗘灦 - -- [Vben Admin](https://github.com/vbenjs/vue-vben-admin) -- [Naive UI](https://www.naiveui.com) -- [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus) - -#### 濡備綍鍙備笌寮�婧愰」鐩� - -璐$尞浣垮紑婧愮ぞ鍖烘垚涓轰竴涓涔犮�佹縺鍔卞拰鍒涢�犵殑缁濅匠鍦烘墍銆備綘鎵�浣滅殑浠讳綍璐$尞閮芥槸**闈炲父鎰熻阿**鐨勩�� - - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - - - ### 鐗堟湰鎺у埗 璇ラ」鐩娇鐢℅it杩涜鐗堟湰绠$悊銆傛偍鍙互鍦╮epository鍙傜湅褰撳墠鍙敤鐗堟湰銆� -### 杩涚兢瀛︿範 -<div> - <img src="image/01.png" alt="drawing" width="300px" height="300px"/> -</div> ### 鐗堟潈璇存槑 璇ラ」鐩娇鐢ㄤ簡MIT鎺堟潈璁稿彲锛岃鎯呰鍙傞槄 [LICENSE.txt](https://github.com/ageerle/ruoyi-ai/blob/main/LICENSE) + +### 浣滆�呭瘎璇� + +鏈�杩戯紝鎴戜滑鐨勯」鐩剰澶栧湴鍙楀埌浜嗗箍娉涘叧娉紝鐢氳嚦琚澶氫汉璇互涓烘槸涓�涓凡缁忔垚鐔熶笖鑳藉蹇�熻惤鍦扮殑椤圭洰銆傜劧鑰岋紝浜嬪疄骞堕潪濡傛銆傝繖涓」鐩槸鎴戜釜浜哄湪涓氫綑鏃堕棿杩涜鐨勭爺绌讹紝涓昏鐩殑鏄涔犲拰鎺㈢储銆傚畠鏄竴涓互浜哄伐鏅鸿兘锛圓I锛変负鏍稿績鐨勫钩鍙帮紝鏃ㄥ湪甯姪浼佷笟閫氳繃閰嶇疆鐨勬柟寮忓揩閫熸瀯寤篈I搴旂敤銆� + +#### 椤圭洰鐜扮姸 + +鐩墠锛岄」鐩繕澶勪簬鏃╂湡闃舵锛岃窛绂绘垚鐔熻繕鏈夊緢闀跨殑璺璧般�傜敱浜庝釜浜虹簿鍔涙湁闄愶紝椤圭洰鐨勫彂灞曢�熷害鍙楀埌浜嗕竴瀹氱殑闄愬埗銆備负浜嗗姞蹇」鐩殑杩涘害锛屾垜鐪熻瘹鍦板笇鏈涙洿澶氫汉鑳藉鍙備笌鍒伴」鐩腑鏉ャ�傛棤璁烘槸缁忛獙涓板瘜鐨勫紑鍙戣�咃紝杩樻槸鍒氬垰鍏ラ棬鐨勫皬鐧斤紝鎴戦兘鐑儓娆㈣繋浣犱滑鎻愪氦Pull Request锛圥R锛夈�傚嵆浣夸唬鐮佷慨鏀瑰緱寰堝皯锛屾垨鑰呭瓨鍦ㄤ竴浜涢敊璇紝閮芥病鏈夊叧绯汇�傛垜浼氳鐪熷鏍告瘡涓�浣嶈础鐚�呯殑浠g爜锛屽苟鍜屽ぇ瀹朵竴璧峰畬鍠勯」鐩�� + +#### 寮�鍙戣鍒� + +- 鏅鸿兘浣撶鐞� + +閫氳繃璁剧疆鎻愮ず璇嶃�佹彃浠躲�佺煡璇嗗簱绛夛紝鐢ㄦ埛鍙互蹇�熸瀯寤轰竴涓狝I搴旂敤銆傝繖灏嗘瀬澶у湴绠�鍖朅I搴旂敤鐨勫紑鍙戞祦绋嬶紝闄嶄綆寮�鍙戦棬妲涳紝浣挎洿澶氫紒涓氳兘澶熻交鏉惧湴鍒╃敤AI鎶�鏈�� +<div> + <img src="image/13.png" alt="drawing" width="600px" height="300px"/> +</div> + +- 娴佺▼缂栨帓 + +閫氳繃娴佺▼缂栨帓鍔熻兘锛岀敤鎴峰彲浠ュ皢涓嶅悓鐨勬ā鍨嬫寜鐓т笟鍔¢�昏緫杩涜鏈夊簭杩炴帴銆傝繖灏嗚В鍐冲崟涓�妯″瀷鑳藉姏涓嶈冻鐨勯棶棰橈紝鍏呭垎鍙戞尌澶氫釜妯″瀷鐨勫崗鍚屼綔鐢紝浠庤�屾洿濂藉湴婊¤冻浼佷笟鐨勫鏉備笟鍔¢渶姹傘�� + +- 鎰熻阿 + +鏈�鍚庯紝鎴戣鎰熻阿RuoYi-Vue-Plus銆乧hatgpt-java銆乧hatgpt-web-midjourney-proxy绛変紭绉�妗嗘灦銆傛鏄洜涓鸿繖浜涢」鐩殑寮�婧愬拰鍏变韩锛屾垜鎵嶈兘澶熷湪杩欎釜鍩虹涓婅繘琛屽紑鍙戯紝浣挎垜浠殑椤圭洰鑳藉鍙栧緱浠婂ぉ鐨勬垚鏋溿�傚啀娆℃劅璋㈣繖浜涢」鐩強鍏惰儗鍚庣殑寮�鍙戣�呬滑锛� + +甯屾湜鏇村蹇楀悓閬撳悎鐨勬湅鍙嬭兘澶熷姞鍏ユ垜浠紝鍏卞悓鎺ㄥ姩杩欎釜椤圭洰鐨勫彂灞曘�傝鎴戜滑涓�璧峰姫鍔涳紝灏嗚繖涓」鐩墦閫犳垚涓�涓湡姝f垚鐔熴�佸疄鐢ㄧ殑AI骞冲彴锛� + +#### 濡備綍鍙備笌寮�婧愰」鐩� + +璐$尞浣垮紑婧愮ぞ鍖烘垚涓轰竴涓涔犮�佹縺鍔卞拰鍒涢�犵殑缁濅匠鍦烘墍銆備綘鎵�浣滅殑浠讳綍璐$尞閮芥槸**闈炲父鎰熻阿**鐨勩�� + +1. Fork 杩欎釜椤圭洰 +2. 鍒涘缓浣犵殑鍔熻兘鍒嗘敮 (`git checkout -b feature/dev`) +3. 鎻愪氦浣犵殑鏇存敼 (`git commit -m 'Add some dev'`) +4. 鎺ㄩ�佸埌鍒嗘敮 (`git push origin feature/dev`) +5. 鎵撳紑鎷夊彇璇锋眰 +6. pr璇锋彁浜ゅ埌GitHub涓婏紝浼氬畾鏃跺悓姝ュ埌gitee + +#### 椤圭洰鏂囨。 +1. 椤圭洰鏂囨。鍩轰簬vitepress鏋勫缓 +2. 鎸夌収[濡備綍鍙備笌寮�婧愰」鐩甝(#濡備綍鍙備笌寮�婧愰」鐩�)鎷夊彇 https://github.com/ageerle/ruoyi-doc +3. 瀹夎渚濊禆锛歯pm install +4. 鍚姩椤圭洰锛歯pm run docs:dev +5. 涓婚〉璺緞锛歞ocs/guide/introduction/index.md + ### 楦h阿 - [chatgpt-java](https://github.com/Grt1228/chatgpt-java) - [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus) - [chatgpt-web-midjourney-proxy](https://github.com/Dooy/chatgpt-web-midjourney-proxy) - +- [Vben Admin](https://github.com/vbenjs/vue-vben-admin) +- [Naive UI](https://www.naiveui.com) <!-- links --> [your-project-path]:https://github.com/ageerle/ruoyi-ai -- Gitblit v1.9.3