مبدل رایگان

README.md ژنراتور قالب

برای پروژه های GitHub خود قالب های حرفه ای README.md ایجاد کنید. بخش‌ها، نشان‌ها و قالب‌بندی را در چند ثانیه سفارشی کنید.

تنظیمات
شامل نشان ها
شامل بخش ها
پشته فناوری
README.md ایجاد شد
# my-project

> A short description of your project.

[![npm version](https://img.shields.io/npm/v/my-project.svg)](https://www.npmjs.com/package/my-project)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/username/repo/ci.yml)](https://github.com/username/repo/actions)

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

```bash
npm install my-project
```

Or using yarn:

```bash
yarn add my-project
```

## Usage

```javascript
const myProject = require('my-project');

// Example usage
// my-project.doSomething();
```

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct.

## License

MIT © [Author Name](https://github.com/username)

See [LICENSE](LICENSE) for more information.

---

Made with by [Author Name](https://github.com/username)

درباره این ابزار

فایل های حرفه ای README.md را برای مخازن GitHub خود ایجاد کنید. بخش‌هایی را برای توضیحات پروژه، نصب، استفاده، مرجع API، دستورالعمل‌های کمک‌کننده و مجوز پر کنید. این ابزار Markdown با ساختار مناسبی را مطابق با استانداردهای انجمن GitHub و بهترین شیوه ها برای اسناد منبع باز تولید می کند.

نحوه استفاده

  1. نام پروژه، توضیحات و ویژگی های کلیدی خود را وارد کنید.
  2. دستورالعمل های نصب و مثال های استفاده را پر کنید.
  3. بخش‌های اختیاری را اضافه کنید: اسناد API، دستورالعمل‌های مشارکتی، مجوز.
  4. Markdown ایجاد شده را کپی کنید و آن را به عنوان README.md در مخزن خود ذخیره کنید.

سوالات متداول

یک README خوب چه بخش هایی باید داشته باشد؟
ضروری: نام/توضیحات پروژه، نصب، مثال‌های استفاده. توصیه می شود: ویژگی ها، مرجع API، دستورالعمل های کمک کننده، مجوز، نشان ها. اختیاری: تصاویر، تغییرات، پرسش‌های متداول، تصدیق.
چه نحوی Markdown در GitHub کار می کند؟
GitHub Flavored Markdown (GFM) از جداول Markdown plus استاندارد، لیست وظایف (- [ ])، بلوک های کد برجسته شده با نحو (```python)، URL های خودکار، خط خطی (~~text~~) و کدهای کوتاه ایموجی (:rocket:) پشتیبانی می کند.
یک README چقدر باید باشد؟
به اندازه کافی طولانی برای کمک به کاربران برای شروع، به اندازه کافی کوتاه است که آن را بخوانند. اکثر README های منبع باز موفق 200-500 خط هستند. از فهرست مطالب برای اسناد طولانی تر استفاده کنید و برای راهنمای دقیق به اسناد جداگانه پیوند دهید.
آیا باید نشان ها را اضافه کنم؟
نشان ها (وضعیت ساخت، نسخه npm، مجوز) شاخص های سریع سلامت پروژه را ارائه می دهند. آنها برای بسته های منبع باز استاندارد هستند. از shields.io برای یک ظاهر طراحی ثابت نشان استفاده کنید.