readme ai

단순성, 사용자 정의 및 개발자 생산성을 위해 설계되었습니다.

빠른 링크

1. 개요

2. 데모

3. 특징

4. 시작하기

5. 구성

6. 예

7. 기여

중요한

자세한 가이드 및 튜토리얼은 공식 문서를 방문하십시오.

개요

ReadMe-AI는 강력한 저장소 프로세싱 엔진 및 고급 언어 모델을 사용하여 README Markdown 파일을 자동으로 생성하는 개발자 도구입니다. 코드베이스에 대한 URL 또는 경로를 제공하면 잘 구조화되고 상세한 readme가 생성됩니다.

왜 readme-ai?

이 도구는 개발자를위한 문서 프로세스를 간소화하고 시간과 노력을 절약하면서 고품질의 readme 파일을 보장하도록 설계되었습니다. 주요 혜택은 다음과 같습니다.

• AI 기반 : 지능형 컨텐츠 생성을위한 언어 모델을 활용합니다.

• 일관성 : 프로젝트 전체에서 깨끗하고 표준화 된 문서를 보장합니다.

• 사용자 정의 : 프로젝트의 요구 사항에 맞게 출력을 조정하십시오.

• 언어 Agnostic : 대부분의 프로그래밍 언어/프레임 워크에서 작동합니다.

• 시간 절약 : 1 분 안에 포괄적 인 readmes를 생성하십시오.

데모

명령 줄에서 실행 :

readmeai-cli-demo.mov

브라우저에서 직접 실행 :

readmeai-streamlit-demo.mov

---

특징

• 자동화 된 문서 : 코드베이스에서 포괄적 인 readme 파일을 자동으로 생성합니다.

• 사용자 정의 가능한 출력 : 스타일링, 포맷, 배지, 헤더 디자인 및 더 많은 선호도를 조정합니다.

• Flexible Backendend : OpenAI , Ollama , Anthropic , Google Gemini 와 완벽하게 통합.

• 언어 Agnostic : 광범위한 프로그래밍 언어 및 프로젝트 유형과 호환됩니다.

• 오프라인 모드 : 외부 API 호출없이 보일러 플레이트 readme 파일을 오프라인으로 만듭니다.

• 모범 사례 : 마크 다운 모범 사례를 준수하여 깨끗하고 전문적인 문서를 보장합니다.

readme-ai가 작성한 몇 가지 가능한 사용자 정의를 살펴 보겠습니다.

씨 대부분의 사용자를위한 권장 방법 : pip Pip 설치 readmeai PIPX PIPX를 사용하여 고립 된 환경에서 readmeai 사용하여 다른 Python 프로젝트와 의존성 충돌을 보장하지 않습니다. pipx 설치 readmeai UV 단일 명령으로 readmeai 설치하는 가장 빠른 방법으로 UV를 사용하십시오. ❯ UV 도구 설치 readmeai 도커 컨테이너화 된 환경에서 readmeai 실행하려면 Docker Hub에서 최신 Docker 이미지를 가져 오십시오. Docker Pull Zeroxeli/ReadMe-AI : 최신 소스에서 지침을 확장하려면 클릭하십시오 저장소 복제 : git 클론 https://github.com/eli64s/readme-ai readme-ai 디렉토리로 이동하십시오. CD README-AI 종속성 설치 : ❯ PIP 설치 -R 설정/요구 사항 .txt 또는 아래의 bash 스크립트를 사용하여 프로젝트를 설정할 수 있습니다. 세게 때리다 설정 스크립트 실행 : setup/setup.sh 또는 poetry 사용하여 프로젝트를 구축하십시오. 시 시를 사용하여 의존성 설치 : ❯시 설치 중요한 의인성 및 Google Gemini 클라이언트를 사용하려면 추가 종속성이 필요합니다. 다음 엑스트라로 패키지를 설치하십시오. 인류 : ❯ PIP 설치 "ReadMeai [Anthropic]" Google Gemini : ❯ PIP 설치 "readMeai [Google-Generativeai]" 여러 클라이언트 설치 : PIP 설치 "ReadMeai [Anthropic, Google-Generativeai]" ? CLI 실행 1. 환경 변수 설정 Openai와 함께 : Openai_api_key = <your_api_key># 또는 Windows 사용자의 경우 : ❯ set openai_api_key = <your_api_key> 추가 제공 업체 (Ollama, Anthropic, Google Gemini) 올라마 Ollama API 설정에 대한 자세한 내용은 Ollama 문서를 참조하십시오. 다음은 기본 예입니다. Ollama 저장소에서 선택한 모델을 가져 오십시오. Ollama Pull Mistral : 최신 Ollama 서버를 시작하고 OLLAMA_HOST 환경 변수를 설정하십시오. Ollama_host = 127.0.0.1 && ollama serv 인류 의인성 API 키를 내보내십시오 : ❯ anthropic_api_key = <your_api_key> 내보내기 Google Gemini Google Gemini API 키로 내보내기 : ❯ export 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-5-240620-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 -repository/path/to/your/project 더 많은 사용자 정의 옵션 추가 : ❯ readmeai -repository https://github.com/eli64s/readme-ai -출력 readmeai.md -api openai -모델 GPT-4 -Badge-Color A931ec -바지 스타일의 평면 -헤더 스타일 컴팩트 -토크 스타일의 접힘 -온도 0.9 -tree-depth 2 --Image llm --emojis 도커 OpenAI 클라이언트와 함께 Docker 컨테이너를 실행하십시오. 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 소스에서 지침을 확장하려면 클릭하십시오 세게 때리다 Bash 스크립트로 소스에서 프로젝트를 설치 한 경우 다음 명령을 실행하십시오. 가상 환경 활성화 : 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-ai-streamlit 저장소를 참조하십시오. 테스트 Pytest 및 Nox 프레임 워크는 개발 및 테스트에 사용됩니다. 시를 사용하여 종속성을 설치하십시오. poetry 시설 -dev, test Pytest를 사용하여 단위 테스트 스위트를 실행하십시오. test 테스트를하십시오 NOX를 사용하여 Python 3.9, 3.10, 3.11 및 3.12에 대해 테스트 스위트를 실행하십시오. test test-nox를 만드십시오 팁 NOX는 여러 파이썬 환경에서 테스트를 자동화하는 자동화 도구입니다. 다양한 파이썬 버전에서 호환성을 보장하는 데 사용됩니다. 구성 이 CLI 옵션을 사용하여 readme 생성을 사용자 정의하십시오. 옵션 설명 기본 --align 헤더의 텍스트 정렬 center --api LLM API 서비스 제공 업체 offline --badge-color 배지 색상 이름 또는 16 진 코드 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-ai에 의해 생성 된 readme 파일보기 : 기술 예제 출력 저장소 설명 readme-ai readme-ai.md readme-ai readme-ai 프로젝트 아파치 플링크 readme-pyflink.md pyflink-poc pyflink 프로젝트 간소 readme-streamlit.md readme-ai-streamlit 간소성 웹 앱 Vercel & npm readme-vercel.md github-readme-quotes Vercel 배포 Go & Docker readme-docker-go.md Docker-GS-PING Dockerized Go 앱 Fastapi & Redis readme-fastapi-redis.md 비동기 ML- 관절 비동기 ML 추론 서비스 자바 readme-java.md 최소-토도 미니멀리스트 TODO Java 앱 Postgresql & duckdb readme-postgres.md 부에나스타 Postgres 프록시 서버 코 틀린 readme-kotlin.md 안드로이드 클라이언트 Android 클라이언트 앱 오프라인 모드 오프라인 모드 .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 특허 Copyright © 2023 Readme-Ai. MIT 라이센스에 따라 릴리스.