Vinkkejä mahtava readme-tiedosto (ja miksi se on tärkeää)
Me, kehittäjät, ovat erittäin hyviä koodilla ja kaikki minuutin yksityiskohdat meidän hankkeita. Mutta jotkut meistä (minä mukaan lukien) eivät ole pehmotaitoisia edes verkkoyhteisössä.,
Kehittäjä käyttäisi tunnin yhden painikkeen pehmusteen ja marginaalin säätämiseen. Mutta ei säästäisi 15 minuuttia projektin kuvaukseen Readme-tiedosto.
toivon, että useimmat teistä tietävät jo, mitä readme.md-tiedosto on ja mihin sitä käytetään. Mutta tulokkaille yritän selittää, mikä se tarkalleen on.
Mikä on Readme.md?
– LUEMINUT-tiedosto (kuten nimestä voi päätellä: ”lue minulle”) on ensimmäinen tiedosto pitäisi lukea, kun aloittaa uuden projektin., Se on joukko hyödyllistä tietoa projektista ja eräänlainen käsikirja. Se on ensimmäinen tiedosto Github tai mikä tahansa git hosting-sivusto näyttää, kun joku avaa arkistosi..
Kuten voit selvästi nähdä täällä Readme.md-tiedosto on root-arkistoon ja näytetään automaattisesti, jonka github alla projektin hakemistoon.
Ja.mdlaajennus tulee sana: markdown., Se on merkintäkieli tekstin muotoiluun. Aivan kuten HTML se on markup kieli tehdä asiakirjamme esitettävissä.
tässä on esimerkki markdownin tiedostosta ja siitä, miten se muuntuu GitHubilla oikeasti. Käytän vscode täällä esikatselu, joka näyttää esikatselun markdown tiedostoja samanaikaisesti.
Tässä on virallinen Github lunttilappua varten Markdown-muodossa, jos haluat viipyä syvälle kielen.
now let ’ s talk business., Käytit tunteja projektiin, julkistit sen GitHubilla ja haluat ihmisiä / rekrytoijat / kollegat/(ENT.) katso projektisi. Luuletko todella, että he menisivät root/src/app/main.js katsoa, että kaunis logiikka omasi? Oikeasti?
nyt kun olen saanut huomionne, katsotaan, miten tähän puututaan.
Tuottaa dokumentaation osia
lisäksi projektin readme -, dokumentointi komponentit on ratkaisevaa ymmärrettäviä codebase. Se helpottaa komponenttien uudelleenkäyttöä ja koodin ylläpitoa., Käytä työkaluja, kuten Bit (Github), luodaksesi automaattisesti dokumentaation bittiin jaetuille komponenteille.dev
Kuvaile projekti! (TL;DR)
Kirjoita hyvä kuvaus projekteistasi. Vain ohjeita, voit muotoilla kuvaus osaksi seuraavia aiheita:-
- Otsikko (Otsikko, Kuva, jos mahdollista, Muokkaa niitä kangas.,com jos et ole graafinen suunnittelija.)
- Kuvaus(Kuvaile sanoja ja kuvia, samanlaisia)
- Demo(Kuvat, Video linkkejä, Live Demo linkkejä)
- Tekniikat
- Erityisiä Kompastuskiviä projekteja (Ongelmia olet kohdannut, ainutlaatuisia elementtejä-hanke)
- Tekninen Kuvaus hanke – asennus, Asennus, Miten edistää.
katsotaanpa sukeltaa syvälle teknisiin yksityiskohtiin
aion käyttää tämän projektin minun viittaus, joka mielestäni on yksi kauneimmista readme-tiedostot olen kirjoittanut ja vieläpä poikki., Voit tarkistaa koodi Readme.md-tiedosto täältä:
Käytä kynä-kuvake näyttää markdown koodi :-
LISÄÄ KUVIA! Ole kiltti!
Sinulla voi olla valokuvamuisti, mutta lukijat saattavat tarvita joitakin todellisia valokuvia demo projektin.
esimerkiksi tein pasianssiprojektin ja lisäsin kuvia kuvauksena readmeen.,
Now you may want to add a video description of your projects too. Just like I did. BUT… Github doesn’t let you add a video to the readme… So… So what?
…WE USE GIFS
Gif kuuluvat luokkaan kuvia ja github avulla sinulla on ne teidän readme.
kunniamerkki
readmeissa olevat merkit antavat katsojalle jonkinlaisen aitouden tunteen., Voit saada custom/säännöllisesti käyttää kilvet(merkit) oman arkiston:- https://shields.io
Voit saada henkilökohtaista kilvet kuten määrä tähtiä repo ja koodin prosenttiosuus indikaattorit liian.
Lisää Live-Esittely
Jos mahdollista saada projektin isännöi ja perustaa käynnissä demo. Tämän jälkeen linkki tämä DEMO README., Sinulla ei ole aavistustakaan, kuinka moni saattaa päätyä leikkimään projekteillasi. Rekrytoija rakastaa live-projekteja. Se osoittaa, että projektisi eivät ole vain koodinpurkaus GitHubissa ja sinä todella tarkoitat bisnestä.
Voit käyttää Linkkejä omalla Readme. Joten anna Live Demo linkki alla otsikko kuva.
Käytä koodia Formatoimalla
Markdown antaa mahdollisuuden muotoilla teksti koodiksi., Joten älä kirjoita koodi tekstinä sen sijaan käyttää ` (Tilde) kääri koodin sisällä koodi muotoilut sellaisenaan- var a = 1;
Github myös antaa sinulle mahdollisuuden määrittää kielen koodi on kirjoitettu niin, että se voi käyttää erityistä tekstin korostuksen tehdä koodia enemmän luettavissa. Voit tehdä tämän käyttää
”{kieli-tiedostotunnistetta}<tilaa>{koodilohkon Sisällä}”
{ ” }- Triple tilde käytetään multi-line-koodin ja sen avulla voit myös määrittää kielen koodi estää.,
With Language Highlighting:-
Without Langage Highlighting:-
Use of HTML
Yes, you can use HTML inside. Not all the features though. But most of it., Vaikka sinun pitäisi pysyä markdown vain mutta joitakin ominaisuuksia, kuten keskitys kuvia ja tekstiä readme on mahdollista vain HTML.
Vastaa