readme ai

ออกแบบมาเพื่อความเรียบง่ายการปรับแต่งและผลผลิตของนักพัฒนา

ลิงค์ด่วน

1. ภาพรวม

2. การสาธิต

3. คุณสมบัติ

4. เริ่มต้น

5. การกำหนดค่า

6. ตัวอย่าง

7. การบริจาค

สำคัญ

เยี่ยมชมเอกสารอย่างเป็นทางการสำหรับคำแนะนำและแบบฝึกหัดโดยละเอียด

ภาพรวม

ReadMe-AI เป็นเครื่องมือนักพัฒนาซอฟต์แวร์ที่สร้างไฟล์ Markdown ReadMe โดยอัตโนมัติโดยใช้เครื่องมือประมวลผลที่เก็บข้อมูลที่แข็งแกร่งและรุ่นภาษาขั้นสูง เพียงจัดเตรียม URL หรือเส้นทางไปยัง codebase ของคุณและจะมีการสร้าง readMe ที่มีโครงสร้างและรายละเอียดอย่างละเอียด

ทำไม readme-ai?

เครื่องมือนี้ได้รับการออกแบบมาเพื่อปรับปรุงกระบวนการจัดทำเอกสารสำหรับนักพัฒนาประหยัดเวลาและความพยายามในขณะที่มั่นใจว่าไฟล์ readme คุณภาพสูง ประโยชน์ที่สำคัญ ได้แก่ :

• AI-Powered: ใช้ประโยชน์จากแบบจำลองภาษาสำหรับการสร้างเนื้อหาอัจฉริยะ

• ความสอดคล้อง: ตรวจสอบเอกสารที่สะอาดและเป็นมาตรฐานในโครงการ

• การปรับแต่ง: ปรับแต่งผลลัพธ์ให้เหมาะกับความต้องการของโครงการของคุณ

• AGNOSTIC ภาษา: ทำงานกับภาษาการเขียนโปรแกรมส่วนใหญ่/เฟรมเวิร์ก

• ประหยัดเวลา: สร้าง readmes ที่ครอบคลุมในเวลาน้อยกว่าหนึ่งนาที

การสาธิต

รันจากบรรทัดคำสั่ง:

READMEAI-CLI-DEMO.MOV

ทำงานโดยตรงในเบราว์เซอร์ของคุณ:

READMEAI-STREAMLIT-DEMO.MOV

---

คุณสมบัติ

• เอกสารอัตโนมัติ: สร้างไฟล์ readme ที่ครอบคลุมโดยอัตโนมัติจาก codebase ของคุณ

• เอาท์พุทที่ปรับแต่งได้: ปรับแต่งสไตล์การจัดรูปแบบป้ายการออกแบบส่วนหัวและการตั้งค่าที่มากขึ้น

• แบ็กเอนด์ที่ยืดหยุ่น: รวมเข้ากับ OpenAI , Ollama , Anthropic , Google Gemini อย่างราบรื่น

• ภาษา AGNOSTIC: เข้ากันได้กับภาษาการเขียนโปรแกรมที่หลากหลายและประเภทโครงการ

• โหมดออฟไลน์: สร้างไฟล์ readme boilerplate ออฟไลน์โดยไม่มีการเรียก API ภายนอกใด ๆ

• แนวทางปฏิบัติที่ดีที่สุด: รับรองเอกสารที่สะอาดและเป็นมืออาชีพปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดของ Markdown

ลองมาดูการปรับแต่งที่เป็นไปได้ที่สร้างโดย ReadMe-AI:

ปิ๊ก วิธีที่แนะนำสำหรับผู้ใช้ส่วนใหญ่: ❯ pip ติดตั้ง readmeai pipx ใช้ PIPX เพื่อใช้ readmeai ในสภาพแวดล้อมที่แยกได้เพื่อให้แน่ใจว่าไม่มีความขัดแย้งในการพึ่งพากับโครงการ Python อื่น ๆ : ❯ pipx ติดตั้ง readmeai UV ใช้ UV สำหรับวิธีที่เร็วที่สุดในการติดตั้ง readmeai ด้วยคำสั่งเดียว: ❯เครื่องมือ UV ติดตั้ง readMeai นักเทียบท่า ในการเรียกใช้ readmeai ในสภาพแวดล้อมที่บรรจุอยู่ให้ดึงภาพนักเทียบท่าล่าสุดจาก Docker Hub: ❯ Docker Pull Zeroxeli/Readme-AI: ล่าสุด จากแหล่งกำเนิด คลิกเพื่อขยายคำแนะนำ โคลนที่เก็บ: ❯ git clone https://github.com/eli64s/readme-ai นำทางไปยังไดเรกทอรี readme-ai : ❯ CD Readme-AI ติดตั้งการพึ่งพา: ❯การติดตั้ง PIP -R SETUP/FRESICE.txt อีกทางเลือกหนึ่งโครงการสามารถตั้งค่าได้โดยใช้สคริปต์ Bash ด้านล่าง: ทุบตี เรียกใช้สคริปต์การตั้งค่า: ❯ bash setup/setup.sh หรือใช้ poetry เพื่อสร้างโครงการ: บทกวี ติดตั้งการพึ่งพาโดยใช้บทกวี: ❯ติดตั้งบทกวี สำคัญ ในการใช้ไคล เอนต์มานุษยวิทยา และ Google Gemini จำเป็นต้องมีการพึ่งพาพิเศษ ติดตั้งแพ็คเกจด้วยความพิเศษต่อไปนี้: มานุษยวิทยา: ❯ PIP ติดตั้ง "readMeai [มานุษยวิทยา]" Google Gemini: ❯ PIP ติดตั้ง "readMeai [google-generativeai]" ติดตั้งไคลเอนต์หลายตัว: ❯ PIP ติดตั้ง "readMeai [มานุษยวิทยา, Google-Generativeai]" - เรียกใช้ CLI 1. ตั้งค่าตัวแปรสภาพแวดล้อม กับ openai: ❯ส่งออก openai_api_key = <your_api_key># หรือสำหรับผู้ใช้ Windows: ❯ตั้ง openai_api_key = <your_api_key> ผู้ให้บริการเพิ่มเติม (Ollama, มานุษยวิทยา, Google Gemini) โอลลา อ้างถึงเอกสาร Ollama สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่า Ollama API นี่คือตัวอย่างพื้นฐาน: ดึงแบบจำลองที่คุณเลือกจากที่เก็บ Ollama: ❯ Ollama Pull Mistral: ล่าสุด เริ่มเซิร์ฟเวอร์ Ollama และตั้งค่าตัวแปรสภาพแวดล้อม OLLAMA_HOST : ❯ส่งออก ollama_host = 127.0.0.1 && ollama เสิร์ฟ มานุษยวิทยา ส่งออกคีย์ API มานุษยวิทยาของคุณ: ❯ส่งออก anthropic_api_key = <your_api_key> Google Gemini ส่งออกคีย์ Google Gemini API ของคุณ: ❯ส่งออก google_api_key = <your_api_key 2. สร้าง readme เรียกใช้คำสั่งต่อไปนี้แทนที่ URL ที่เก็บด้วยตัวคุณเอง: ❯ readMeai-repository https://github.com/eli64s/readme-ai-Api Openai สำคัญ โดยค่าเริ่มต้นจะใช้รุ่น gpt-3.5-turbo ค่าใช้จ่ายที่สูงขึ้นอาจเกิดขึ้นเมื่อโมเดลขั้นสูงมากขึ้น ดำเนินการกับ Ollama และตั้ง llama3 เป็นนางแบบ: ❯ readMeai-API Ollama-Model Llama3-repository https://github.com/eli64s/readme-ai วิ่งกับ Anthropic : ❯ readMeai-API anthropic -m claude-3-5-sonnet-20240620 -r https://github.com/eli64s/readme-ai เรียกใช้กับ Google Gemini : ❯ readMeai-API GEMINI -M gemini-1.5-flash -r https://github.com/eli64s/readme-ai ใช้เส้นทางไดเรกทอรี local : readMeai -การสำเนา/เส้นทาง/ไป/ของคุณ/โครงการ เพิ่มตัวเลือกการปรับแต่งเพิ่มเติม: ❯ readMeai-repository https://github.com/eli64s/readme-ai -OUTPUT READMEAI.MD -Api Openai -รุ่น GPT-4 -สีน้ำตาล A931EC -สแควร์แบน -ขนาดกะทัดรัด -แบบพับ -อุณหภูมิ 0.9 -ทรีลึก 2 -ภาพ llm -เอ็มโมจิส นักเทียบท่า เรียกใช้คอนเทนเนอร์ Docker ด้วยไคลเอนต์ OpenAI: ❯ Docker Run -it - -rm -e openai_api_key = $ openai_api_key -v "$ (PWD)":/แอพ Zeroxeli/ReadMe-AI: ล่าสุด -repository https://github.com/eli64s/readme-ai -Api Openai จากแหล่งกำเนิด คลิกเพื่อขยายคำแนะนำ ทุบตี หากคุณติดตั้งโครงการจากแหล่งที่มาด้วยสคริปต์ทุบตีให้เรียกใช้คำสั่งต่อไปนี้: เปิดใช้งานสภาพแวดล้อมเสมือนจริง: ❯ conda เปิดใช้งาน readMeai เรียกใช้ CLI: ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai บทกวี เปิดใช้งานสภาพแวดล้อมเสมือนจริง: ❯เชลล์บทกวี เรียกใช้ CLI: ❯บทกวีเรียกใช้ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai มีแสงสว่าง ลอง readme-AI โดยตรงในเบราว์เซอร์ของคุณไม่จำเป็นต้องติดตั้ง ดูที่เก็บ readme-atreamlit สำหรับรายละเอียดเพิ่มเติม การทดสอบ เฟรมเวิร์ก PyTest และ NOX ใช้สำหรับการพัฒนาและการทดสอบ ติดตั้งการอ้างอิงโดยใช้บทกวี: ❯การติดตั้งบทกวี -กับ dev, ทดสอบ เรียกใช้ชุดทดสอบหน่วยโดยใช้ pytest: ❯ทำการทดสอบ เรียกใช้ชุดทดสอบกับ Python 3.9, 3.10, 3.11 และ 3.12 โดยใช้ NOX: ❯ทำการทดสอบ -nox เคล็ดลับ NOX เป็นเครื่องมืออัตโนมัติที่ทำการทดสอบโดยอัตโนมัติในสภาพแวดล้อม Python หลาย ๆ สภาพ มันถูกใช้เพื่อให้แน่ใจว่าเข้ากันได้ในเวอร์ชันหลามที่แตกต่างกัน การกำหนดค่า ปรับแต่งการสร้าง readme ของคุณโดยใช้ตัวเลือก CLI เหล่านี้: ตัวเลือก คำอธิบาย ค่าเริ่มต้น --align การจัดตำแหน่งข้อความในส่วนหัว center --api ผู้ให้บริการ LLM API offline --badge-color ชื่อป้ายสีหรือรหัสฐานสิบหก 0080ff --badge-style ประเภทไอคอนสัญลักษณ์ประเภท flat --header-style รูปแบบเทมเพลตส่วนหัว classic --toc-style สารบัญสไตล์ bullet --emojis เพิ่มอิโมจิในส่วนส่วนหัว readme False --image ภาพโลโก้โครงการ blue --model รุ่น LLM เฉพาะที่จะใช้ gpt-3.5-turbo --output ชื่อไฟล์เอาต์พุต readme-ai.md --repository URL ที่เก็บหรือเส้นทางไดเรกทอรีท้องถิ่น None --temperature ระดับความคิดสร้างสรรค์สำหรับการสร้างเนื้อหา 0.1 --tree-depth ความลึกสูงสุดของโครงสร้างต้นไม้ไดเรกทอรี 2 เรียกใช้คำสั่งต่อไปนี้เพื่อดูตัวเลือกที่มีอยู่ทั้งหมด: ❯ readmeai -help เยี่ยมชมเอกสารอย่างเป็นทางการสำหรับข้อมูลรายละเอียดเพิ่มเติมเกี่ยวกับตัวเลือกการกำหนดค่าตัวอย่างและแนวทางปฏิบัติที่ดีที่สุด ตัวอย่าง ดูตัวอย่างไฟล์ readme ที่สร้างโดย ReadMe-AI ในซ้อนเทคโนโลยีต่างๆ: เทคโนโลยี ตัวอย่างเอาต์พุต ที่เก็บ คำอธิบาย readme-AI readme-ai.md readme-AI โครงการ readme-ai Apache Flink readme-pyflink.md Pyflink-poc โครงการ Pyflink มีแสงสว่าง readme-treamlit.md readme-ai-streamlit แอปพลิเคชั่นเว็บ vercel & npm readme-vercel.md gitHub-readme-quotes การปรับใช้ vercel ไป & นักเทียบท่า readme-docker-go.md Docker-gs-ping แอป Dockerized Go Fastapi & Redis readme-fastapi redis.md async-ml-inference บริการอนุมาน Async ML ชวา readme-java.md ขั้นต่ำสุด แอพ ToDo Java ที่เรียบง่าย PostgreSql & Duckdb readme-postgres.md Buenavista Postgres Proxy Server Kotlin readme-kotlin.md Android-client แอพไคลเอนต์ Android โหมดออฟไลน์ Offline-mode.md Litellm บริการ LLM API ค้นหาตัวอย่าง readme เพิ่มเติมในไดเรกทอรีตัวอย่าง แผนงาน เปิด readmeai 1.0.0 พร้อมคุณสมบัติการจัดการเอกสารขั้นสูง พัฒนา Vscode Extension เพื่อสร้างไฟล์ readMe โดยตรงในตัวแก้ไข พัฒนาการ GitHub Actions เพื่ออัปเดตเอกสารโดยอัตโนมัติ เพิ่ม badge packs เพื่อจัดทำสไตล์และตัวเลือกของตราเพิ่มเติม ความครอบคลุมของรหัสสถานะ CI/CD เวอร์ชันโครงการและอื่น ๆ การบริจาค ยินดีต้อนรับ! โปรดอ่านคู่มือการสนับสนุนเพื่อเริ่มต้น คู่มือการบริจาค : เรียนรู้เกี่ยวกับกระบวนการสนับสนุนและมาตรฐานการเข้ารหัสของเรา - รายงานปัญหา : พบข้อผิดพลาด? แจ้งให้เราทราบ! เริ่มการสนทนา : มีความคิดหรือข้อเสนอแนะ? เราชอบที่จะได้ยินจากคุณ กิตติกรรมประกาศ shields.io ไอคอนง่ายๆ Aveek-Saha/GitHub-Profile-Badges Ileriayo/Markdown-Badges tandpfun/skill-icons ใบอนุญาต ลิขสิทธิ์© 2023 README-AI ปล่อยภายใต้ใบอนุญาต MIT