Megosztás a következőn keresztül:

README fájl az NuGet.org-on

Adjon meg egy olvasófájlt a NuGet-csomagban , hogy a csomag részletei gazdagabbak és informatívabbak legyenek a felhasználók számára!

Ez valószínűleg az egyik első elem, amelyet a felhasználók látni fognak, amikor megtekintik a csomag részleteit tartalmazó oldalt NuGet.org, és elengedhetetlen ahhoz, hogy jó benyomást tegyenek!

Fontos

NuGet.org csak a Markdownban lévő olvasási fájlokat és a korlátozott tartományból származó képeket támogatja. Tekintse meg az engedélyezett domaineket a képekhez és a támogatott Markdown-funkciókat, hogy a readme helyesen jelenjen meg a NuGet.org webhelyen.

Mit kell tartalmaznia a README fájlnak?

Az alábbi elemeket vegye fel a readme fájlba:

  • Bevezetés a csomagra és annak céljára – milyen problémákat old meg?
  • Hogyan kezdheti el a csomagot – vannak bizonyos követelmények?
  • Az átfogóbb dokumentációra mutató hivatkozások, ha nincsenek feltüntetve magában a readme fájlban.
  • Legalább néhány kódrészlet/minta vagy példakép.
  • Hol és hogyan hagyhatja el a visszajelzéseket, például a projektproblémákra mutató hivatkozást, a Twittert, a hibakövetőt vagy más platformot.
  • Ha lehetséges, hogyan járulhat hozzá.

Első lépésként használhatja például ezt a README-sablont:

# Package readme title, e.g., display name or title of the package (optional)

Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves.

## Getting started

Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.

### Prerequisites

What are specific minimum requirements to use your packages? Consider excluding this section if your package works without any additional setup beyond simple package installation.

## Usage

Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable. 

- Provide sample code using code snippets
- Include screenshots, diagrams, or other visual help users better understand how to use your package

## Additional documentation

Provide links to more resources: List links such as detailed documentation, tutorial videos, blog posts, or any other relevant documentation to help users get the most out of your package.

## Feedback

Where and how users can leave feedback?

- Links to a GitHub repository where could open issues, Twitter, a Discord channel, bug tracker, or other platforms where a package consumer can connect with the package author.

Ne feledje, hogy a kiváló minőségű readme fájlok számos formátumban és méretben is elérhetők! Ha már rendelkezik egy csomaggal a NuGet.org weboldalon, akkor valószínű, hogy már van egy readme.md vagy más dokumentációs fájl az adattárban, amely nagyszerűen kiegészítené a NuGet.org részletes lapját.

Megjegyzés:

Olvassa el blogunkat a magas színvonalú README írásának legjobb gyakorlatairól, hogy megismerje néhány ajánlást.

Tekintse meg a readme fájlt

Ha a NuGet.org élőben való használata előtt szeretné megtekinteni az olvasófájlt, töltse fel a csomagot a Csomag feltöltése webes portálon NuGet.org, és görgessen le a metaadatok előnézetének "Readme Fájl" szakaszához. Ennek az alábbihoz hasonlónak kell lennie:

Readme-fájl előnézet

Fontolja meg a README fájl felülvizsgálatát és megtekintését a képmegfelelőség és támogatott formázás érdekében, hogy az jó benyomást tegyen a potenciális felhasználókra! Ahhoz, hogy kijavítsd a hibákat a NuGet.org-ra feltöltött csomagod readme-jében, fel kell töltened egy javított csomagverziót. Ha előzetesen meggyőződik arról, hogy minden rendben van, a jövőben elkerülheti a fejfájást.

Képek és jelvények engedélyezett tartományai

Biztonsági és adatvédelmi megfontolások miatt a NuGet.org korlátozza azokat a tartományokat, amelyekről képek és jelvények jeleníthetők meg megbízható gazdagépeken.

NuGet.org lehetővé teszi az alábbi megbízható tartományokból származó összes kép megjelenítését, beleértve a jelvényeket is:

  • api.codacy.com
  • api.codeclimate.com
  • api.dependabot.com
  • api.reuse.software
  • api.travis-ci.com
  • app.codacy.com
  • app.deepsource.com
  • avatars.githubusercontent.com
  • badgen.net
  • badges.gitter.im
  • camo.githubusercontent.com
  • caniuse.bitsofco.de
  • cdn.jsdelivr.net
  • cdn.syncfusion.com
  • ci.appveyor.com
  • circleci.com
  • cloudback.it
  • codecov.io
  • codefactor.io
  • coveralls.io
  • dev.azure.com
  • flat.badgen.net
  • github.com/.../workflows/.../badge.svg
  • gitlab.com
  • i.imgur.com
  • img.shields.io
  • infragistics.com
  • isitmaintained.com
  • media.githubusercontent.com
  • opencollective.com
  • raw.github.com
  • raw.githubusercontent.com
  • snyk.io
  • sonarcloud.io
  • travis-ci.com
  • travis-ci.org
  • user-images.githubusercontent.com

Ha úgy érzi, hogy egy másik tartományt kell hozzáadnia az engedélyezési listához, nyugodtan küldjön egy problémát , és a mérnöki csapatunk felülvizsgálja az adatvédelmi és biztonsági megfelelőség érdekében. A relatív helyi elérési utakat és nem támogatott tartományokból származó képeket tartalmazó képek nem fognak megjelenni. Ezek figyelmeztetést eredményeznek a readme fájl előnézetén és a csomag részleteinek oldalán, amelyek csak a csomagtulajdonosok számára láthatók.

Támogatott Markdown-funkciók

A Markdown egyszerűen kezelhető jelölőnyelv, amely egyszerű szöveg formázására alkalmas szintaxist használ. NuGet.org olvasási műveletek támogatják a CommonMark-kompatibilis Markdownt a Markdig elemzőmotoron keresztül.

NuGet.org jelenleg a következő Markdown-funkciókat támogatja:

A szintaxiskiemelést is támogatjuk. Hozzáadhat egy nyelvi azonosítót, amely lehetővé teszi a szintaxiskiemelést a kódtartományokban.

  • Last updated on