ነጻ መለወጫ

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)

ስላዚህ መሳሪያ

ለ GitHub ማከማቻዎችዎ ፕሮፌሽናል README.md ፋይሎችን ይፍጠሩ። ለፕሮጀክት መግለጫ፣ ጭነት፣ አጠቃቀም፣ የኤፒአይ ማጣቀሻ፣ የአስተዋጽኦ መመሪያዎች እና ፍቃድ ክፍሎችን ይሙሉ። መሳሪያው የ GitHub ማህበረሰብ ደረጃዎችን እና ለክፍት ምንጭ ሰነዶች ምርጥ ተሞክሮዎችን በመከተል በደንብ የተዋቀረ ማርክዳውን ያዘጋጃል።

እንዴት ይጠቀሙ

  1. የፕሮጀክትዎን ስም፣ መግለጫ እና ቁልፍ ባህሪያት ያስገቡ።
  2. የመጫኛ መመሪያዎችን እና የአጠቃቀም ምሳሌዎችን ይሙሉ።
  3. አማራጭ ክፍሎችን ያክሉ፡ የኤፒአይ ሰነዶች፣ የአስተዋጽኦ መመሪያዎች፣ ፍቃድ።
  4. የተፈጠረውን Markdown ይቅዱ እና እንደ README.md በእርስዎ ማከማቻ ውስጥ ያስቀምጡት።

በተደጋጋሚ የሚጠየቁ ጥያቄዎች

ጥሩ README ምን ክፍሎች ሊኖሩት ይገባል?
አስፈላጊ: የፕሮጀክት ስም / መግለጫ, ጭነት, የአጠቃቀም ምሳሌዎች. የሚመከር፡ ባህሪያት፣ የኤፒአይ ማጣቀሻ፣ የአስተዋጽኦ መመሪያዎች፣ ፍቃድ፣ ባጆች። አማራጭ፡ ቅጽበታዊ ገጽ እይታዎች፣ የለውጥ ሎግ፣ ተደጋጋሚ ጥያቄዎች፣ ምስጋናዎች።
በ GitHub ላይ ምን Markdown አገባብ ይሰራል?
GitHub Flavored Markdown (ጂኤፍኤም) መደበኛ ማርክዳውን እና ሰንጠረዦችን፣ የተግባር ዝርዝሮችን (- [])፣ በአገባብ የደመቁ የኮድ ብሎኮችን (```python)፣ በራስ የተገናኙ ዩአርኤሎችን፣ አድማ (~~ጽሑፍ ~~) እና የኢሞጂ አቋራጮችን (፡ሮኬት፡) ይደግፋል።
README ለምን ያህል ጊዜ መሆን አለበት?
ተጠቃሚዎች እንዲጀምሩ ለማገዝ በቂ ነው፣ ያነበቡት አጭር ነው። በጣም የተሳካላቸው ክፍት ምንጭ READMEs 200-500 መስመሮች ናቸው። ረዘም ላለ ሰነዶች የይዘት ሠንጠረዥ ይጠቀሙ እና ለዝርዝር መመሪያዎች ሰነዶችን ለመለየት አገናኝ።
ባጆችን ማካተት አለብኝ?
ባጆች (የግንባታ ሁኔታ፣ npm ስሪት፣ ፍቃድ) ፈጣን የፕሮጀክት የጤና አመልካቾችን ይሰጣሉ። ለክፍት ምንጭ ፓኬጆች መደበኛ ናቸው። ለተከታታይ ባጅ አሰራር shields.io ይጠቀሙ።