readme ai

Dirancang untuk kesederhanaan, penyesuaian, dan produktivitas pengembang.

Tautan cepat

1. Ringkasan

2. Demo

3. Fitur

4. Memulai

5. Konfigurasi

6. Contoh

7. Berkontribusi

Penting

Kunjungi dokumentasi resmi untuk panduan dan tutorial terperinci.

Ringkasan

ReadMe-AI adalah alat pengembang yang secara otomatis menghasilkan file markdown readme menggunakan mesin pemrosesan repositori yang kuat dan model bahasa canggih. Cukup berikan URL atau jalur ke basis kode Anda, dan readme yang terstruktur dengan baik dan terperinci akan dihasilkan.

Mengapa Readme-ai?

Alat ini dirancang untuk merampingkan proses dokumentasi untuk pengembang, menghemat waktu dan upaya sambil memastikan file readme berkualitas tinggi. Manfaat utama termasuk:

• AI-Powered: Model Bahasa Leverage untuk Pembuatan Konten Cerdas.

• Konsistensi: Pastikan dokumentasi yang bersih dan standar di seluruh proyek.

• Kustomisasi: Sesuaikan output agar sesuai dengan kebutuhan proyek Anda.

• Bahasa agnostik: bekerja dengan sebagian besar bahasa/kerangka kerja pemrograman.

• Hemat Waktu: Hasilkan Readmes komprehensif dalam waktu kurang dari satu menit.

Demo

Berjalan dari baris perintah:

ReadMeai-cli-demo.mov

Berlari langsung di browser Anda:

ReadMeai-streamlit-demo.mov

---

Fitur

• Dokumentasi Otomatis: Hasilkan file readme yang komprehensif secara otomatis dari basis kode Anda.

• Output yang dapat disesuaikan: menyesuaikan gaya, pemformatan, lencana, desain header, dan lebih banyak preferensi.

• Backends Fleksibel: Integrasi mulus dengan OpenAI , Ollama , Anthropic , Google Gemini .

• Bahasa agnostik: Kompatibel dengan berbagai bahasa pemrograman dan jenis proyek.

• Mode offline: Buat file readme boilerplate offline, tanpa panggilan API eksternal.

• Praktik Terbaik: Memastikan dokumentasi yang bersih dan profesional, mematuhi praktik terbaik yang ditandai.

Mari kita lihat beberapa kemungkinan kustomisasi yang dibuat oleh Readme-ai:

Pip Metode yang disarankan untuk sebagian besar pengguna: ❯ Pip Instal ReadMeai Pipx Gunakan PIPX untuk menggunakan readmeai di lingkungan yang terisolasi, memastikan tidak ada konflik ketergantungan dengan proyek Python lainnya: ❯ Pipx Instal ReadMeai UV Gunakan UV untuk cara tercepat untuk menginstal readmeai dengan satu perintah: ❯ Alat UV Instal ReadMeai Buruh pelabuhan Untuk menjalankan readmeai di lingkungan yang dimasukkan, tarik gambar Docker terbaru dari Docker Hub: ❯ Docker Tarik Zeroxeli/Readme-ai: Terbaru Dari sumber Klik untuk memperluas instruksi Klon Repositori: ❯ Git Clone https://github.com/eli64s/readme-ai Arahkan ke direktori readme-ai : ❯ CD Readme-ai Instal dependensi: ❯ PIP menginstal -r setup/persyaratan.txt Atau, proyek dapat diatur menggunakan skrip bash di bawah ini: Pesta Jalankan skrip pengaturan: ❯ Bash Setup/Setup.sh Atau, gunakan poetry untuk membangun proyek: Puisi Instal dependensi menggunakan puisi: ❯ instalasi puisi Penting Untuk menggunakan klien antropik dan Google Gemini , diperlukan ketergantungan ekstra. Instal paket dengan ekstra berikut: Antropik: ❯ Pip Instal "ReadMeai [Antropik]" Google Gemini: ❯ Pip Instal "ReadMeai [Google-Generativeai]" Instal banyak klien: ❯ Pip Instal "ReadMeai [Antropik, Google-Generativeai]" ? Menjalankan CLI 1. Mengatur variabel lingkungan Dengan openai: ❯ Ekspor OpenAI_API_KEY = <Mu_api_key># Atau untuk pengguna Windows: ❯ Setel openai_api_key = <your_api_key> Penyedia tambahan (Ollama, Antropik, Google Gemini) Ollama Lihat dokumentasi Ollama untuk informasi lebih lanjut tentang pengaturan API Ollama. Berikut adalah contoh dasar: Tarik model pilihan Anda dari repositori Ollama: ❯ Ollama Pull Mistral: Terbaru Mulai server Ollama dan atur variabel lingkungan OLLAMA_HOST : ❯ Ekspor ollama_host = 127.0.0.1 && ollama serve Antropik Ekspor Kunci API Antropik Anda: ❯ Ekspor antropic_api_key = <your_api_key> Google Gemini Ekspor Kunci API Google Gemini Anda: ❯ Ekspor google_api_key = <your_api_key 2. Hasilkan readme Jalankan perintah berikut, ganti URL repositori dengan Anda sendiri: ❯ ReadMeai --Repository https://github.com/eli64s/readme-ai --api openai Penting Secara default, model gpt-3.5-turbo digunakan. Biaya yang lebih tinggi mungkin terjadi ketika model yang lebih maju. Jalankan dengan Ollama dan atur llama3 sebagai model: ❯ ReadMeai --Api Ollama --Deram Llama3 --Repositori https://github.com/eli64s/readme-ai Jalankan dengan Anthropic : ❯ ReadMeai --API Anthropic -M Claude-3-5-Sonnet-20240620 -r https://github.com/eli64s/readme-ai Jalankan dengan Google Gemini : ❯ ReadMeai --api Gemini -M Gemini-1.5-flash -r https://github.com/eli64s/readme-ai Gunakan jalur direktori local : ReadMeai -Repositori/Path/To/Your/Project Tambahkan lebih banyak opsi kustomisasi: ❯ ReadMeai --Repositori https://github.com/eli64s/readme-ai -output readMeai.md --API OpenAI -Model GPT-4 --ladge-color A931EC -Flat-square-flat-style -Header-style compact -Toc-style lip -Temperatur 0.9 --Tree-Depth 2 --Image llm --Mojis Buruh pelabuhan Jalankan wadah Docker dengan klien openai: ❯ Docker run -it --rm -E OPENAI_API_KEY = $ openai_api_key -v "$ (pwd)":/app Zeroxeli/readme-ai: terbaru --Repositori https://github.com/eli64s/readme-ai --API OpenAI Dari sumber Klik untuk memperluas instruksi Pesta Jika Anda menginstal proyek dari sumber dengan skrip bash, jalankan perintah berikut: Aktifkan lingkungan virtual: ❯ conda mengaktifkan readMeai Jalankan CLI: ❯ python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai Puisi Aktifkan lingkungan virtual: ❯ Shell puisi Jalankan CLI: ❯ puisi menjalankan python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai Streamlit Coba ReadMe-Ai langsung di browser Anda, tidak diperlukan instalasi. Lihat Repositori ReadMe-Ai-Streamlit untuk detail lebih lanjut. Pengujian Kerangka kerja Pytest dan NOx digunakan untuk pengembangan dan pengujian. Instal dependensi menggunakan puisi: ❯ instalasi puisi -dengan dev, tes Jalankan unit test suite menggunakan pytest: ❯ Tes Jalankan test suite melawan Python 3.9, 3.10, 3.11, dan 3.12 menggunakan NOX: ❯ Buat tes-nox Tip NOX adalah alat otomatisasi yang mengotomatiskan pengujian di beberapa lingkungan Python. Ini digunakan untuk memastikan kompatibilitas di berbagai versi Python. Konfigurasi Kustomisasi generasi readme Anda menggunakan opsi CLI ini: Pilihan Keterangan Bawaan --align Penyelarasan teks di header center --api Penyedia Layanan API LLM offline --badge-color Nama warna lencana atau kode hex 0080ff --badge-style Jenis Gaya Ikon Lencana flat --header-style Gaya template header classic --toc-style Gaya Daftar Isi bullet --emojis Menambahkan emoji ke bagian header readme False --image Gambar logo proyek blue --model Model LLM spesifik untuk digunakan gpt-3.5-turbo --output Nama file output readme-ai.md --repository URL repositori atau jalur direktori lokal None --temperature Tingkat Kreativitas untuk Pembuatan Konten 0.1 --tree-depth Kedalaman maksimum struktur pohon direktori 2 Jalankan perintah berikut untuk melihat semua opsi yang tersedia: ❯ ReadMeai --help Kunjungi dokumentasi resmi untuk informasi lebih rinci tentang opsi konfigurasi, contoh, dan praktik terbaik. Contoh Lihat contoh file readme yang dihasilkan oleh readme-ai di berbagai tumpukan teknologi: Teknologi Output contoh Gudang Keterangan Readme-ai readme-ai.md readme-ai Proyek Readme-Ai Baku Apache readme-pyflink.md Pyflink-Poc Proyek Pyflink Streamlit readme-streamlit.md readme-ai-streamlit Aplikasi Web StreamLit Vercel & NPM readme-vercel.md Kutipan GitHub-Readme Penerapan Vercel Go & Docker readme-docker-o.md Docker-GS-Ping Aplikasi GO Dockerized Fastapi & Redis readme-fastapi-bedis.md Async-ML-Inferensi Async ML Inference Service Jawa README-JAVA.MD Minimal-Todo Aplikasi Java Minimalis Todo PostgreSQL & DuckDB README-POSTGRES.MD Buenavista Server Proxy Postgres Kotlin ReadMe-Kotlin.md Android-Client Aplikasi Klien Android Mode offline Offline-Mode.md litellm LLM API Service Temukan contoh readme tambahan di direktori contoh. Peta jalan Rilis readmeai 1.0.0 dengan fitur manajemen dokumentasi yang ditingkatkan. Kembangkan Vscode Extension untuk menghasilkan file readME secara langsung di editor. Kembangkan GitHub Actions untuk mengotomatiskan pembaruan dokumentasi. Tambahkan badge packs untuk memberikan gaya dan opsi lencana tambahan. Cakupan kode, status CI/CD, versi proyek, dan banyak lagi. Berkontribusi Kontribusi dipersilakan! Harap baca panduan yang berkontribusi untuk memulai. Panduan Kontribusi : Pelajari tentang proses kontribusi dan standar pengkodean kami. ? Laporkan masalah : Menemukan bug? Beri tahu kami! Mulailah diskusi : Punya ide atau saran? Kami ingin mendengar dari Anda. Ucapan Terima Kasih Shields.io Ikon sederhana Aveek-saha/github-profile-badges Ileriayo/Markdown-Badges Tandpfun/Skill-Icons Lisensi Hak Cipta © 2023 Readme-ai. Dirilis di bawah lisensi MIT.