Bezplatný prevodník

README.md Generátor šablón

Vytvorte profesionálne šablóny README.md pre svoje projekty GitHub. Prispôsobte sekcie, odznaky a formátovanie v priebehu niekoľkých sekúnd.

Nastavenia
Zahrnúť odznaky
Zahrnúť sekcie
Tech Stack
Vygenerovaný súbor 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)

O tomto nástroji

Vytvorte profesionálne súbory README.md pre svoje úložiská GitHub. Vyplňte sekcie pre popis projektu, inštaláciu, použitie, referenciu API, pokyny na prispievanie a licenciu. Tento nástroj vytvára dobre štruktúrovaný Markdown podľa štandardov komunity GitHub a osvedčených postupov pre dokumentáciu s otvoreným zdrojom.

Ako používať

  1. Zadajte názov projektu, popis a kľúčové vlastnosti.
  2. Vyplňte pokyny na inštaláciu a príklady použitia.
  3. Pridajte voliteľné sekcie: dokumenty API, pokyny pre prispievanie, licencia.
  4. Skopírujte vygenerovaný Markdown a uložte ho ako README.md do svojho úložiska.

Často kladené otázky

Aké sekcie by mal mať dobrý README?
Nevyhnutné: názov/popis projektu, inštalácia, príklady použitia. Odporúčané: funkcie, referencia API, pokyny na prispievanie, licencia, odznaky. Voliteľné: screenshoty, changelog, FAQ, potvrdenia.
Aká syntax Markdown funguje na GitHub?
GitHub Flavored Markdown (GFM) podporuje štandardné tabuľky Markdown plus, zoznamy úloh (- [ ]), bloky kódu so zvýraznenou syntaxou (```python), automaticky prepojené adresy URL, prečiarknuté (~~text~~) a krátke kódy emoji (:rocket:).
Ako dlhý by mal byť README?
Dostatočne dlhý na to, aby pomohol používateľom začať, dostatočne krátky na to, aby si ho prečítali. Najúspešnejšie súbory README s otvoreným zdrojom majú 200 – 500 riadkov. Pre dlhšie dokumenty použite obsah a prepojte samostatné dokumenty s podrobnými sprievodcami.
Mám zahrnúť odznaky?
Odznaky (stav zostavy, verzia npm, licencia) poskytujú rýchle indikátory stavu projektu. Sú štandardom pre balíky s otvoreným zdrojovým kódom. Použite shields.io na konzistentný štýl odznaku.