seuraavat osat ja malli perustuvat panos monia, jotka ovat osallistuneet keskusteluun ”Luoda README.txt-malli”. Lihallisen esimerkin vuoksi käytämme näytetekstiä. Suurin osa siitä tulee Hallintovalikon moduulin README.txt.

Sisällysluettelo

Tosc-tiedostot ovat valinnaisia, mutta niitä arvostetaan pitkällisiin README-tiedostoihin.,

Johdanto

käyttöönotto (pakollinen) koostuu lyhyt kappale tai kaksi, joka on yhteenveto tarkoitus ja tehtävä tämän hankkeen. Tämä johdanto voi olla sama kuin projektin sivun ensimmäinen kappale.

johdannon tulisi sisältää linkki projektin sivulle ja numerojonoon. Jos hanke on hiekkalaatikko, näiden linkkien pitäisi mennä hiekkalaatikolle promootioon asti.

Vaatimukset

vaatimukset jakso (pakollinen) tulee tehdä selväksi, onko tämä hanke edellyttää mitään ulkopuolella Drupal core töihin (moduulit, kirjastot, jne.)., Luettele kaikki vaatimukset Tässä, mukaan lukien ne, jotka seuraavat epäsuorasti toisesta moduulista jne. Ideana on kertoa käyttäjille, mitä tarvitaan, jotta kaikki mitä he tarvitsevat voidaan hankkia ja sisällyttää etukäteen yrittää asentaa moduulin. Jos vaatimuksia ei ole, kirjoita ”Ei erityisvaatimuksia”.

REQUIREMENTS------------This module requires no modules outside of Drupal core.

Suositeltu moduulit

Tämä valinnainen osassa luetellaan moduulit, jotka ovat ei vaadita, mutta se voi parantaa hyödyllisyyttä tai käyttäjän kokemus projektin. Muista kuvata hyödyt mahdollistamalla nämä moduulit.,

Asennus

asennus kohta (pakollinen*) on tehtävä selväksi, miten asentaa moduuli. Kuitenkin, jos asenna moduuli noudattaa standardin ohjeita Drupal 8, Drupal 7, Drupal 6/5, tai teema, älä keksiä pyörää uudelleen — vain antaa linkki, ja selittää yksityiskohtaisesti kaikki vaiheet, jotka saattavat poiketa nämä vaiheet. Huomioi erityisesti Drush-integraatiot. Jos Drush-komentoja lisätään useita, harkitse Drush-kohdan lisäämistä.

harkitse tämän osan korvaamista erillisellä asennuksella.,txt-tiedosto, jos asennusohjeesi ovat erityisen monimutkaiset.

* – vaaditaan, ellei erillistä asennusta ole.txt on varattu.

Drupal 7

Drupal 8

Kokoonpano

kokoonpano jakso (pakollinen) on tarpeen silloinkin, kun pieni kokoonpano on tarpeen. Käytä tätä osiota luetellaksesi erityisiä muistiinpanoja Tämän moduulin kokoonpanosta – mukaan lukien mutta ei rajoittuen käyttöoikeuksiin. Tämä osio on erityisen tärkeä, jos moduuli vaatii lisäasetukset Drupal UI: n ulkopuolella.,

Jos moduulissa on vähän tai ei lainkaan konfiguraatiota, sinun tulisi käyttää tätä tilaa selittääksesi, miten moduulin käyttöönotto / poistaminen käytöstä vaikuttaa sivustoon.

CONFIGURATION------------- * Configure the user permissions in Administration " People " Permissions: - Use the administration pages and help (System module) The top-level administration categories require this permission to be accessible. The administration menu will be empty unless this permission is granted. - Access administration menu Users with this permission will see the administration menu at the top of each page. - Display Drupal links Users with this permission will receive links to drupal.org issue queues for all enabled contributed modules. The issue queue links appear under the administration menu icon. * Customize the menu settings in Administration " Configuration and modules " Administration " Administration menu. * To prevent administrative menu items from appearing twice, you may hide the "Management" menu block.

tai

Vianmääritys & UKK

Nämä kohdat ovat valinnaisia. Jos ne ovat läsnä, niiden tulisi käsitellä kysymyksiä, joita kysytään usein numerojonossa (tämä säästää aikaa tulevaisuudessa). Hahmotella yhteisiä ongelmia, että ihmiset kohtaavat yhdessä ratkaisuja (linkit ovat ok, jos vaiheet ovat pitkiä, mutta se on usein hyödyllistä tarjota yhteenveto koska linkit joskus mennä tunkkainen).,

ylläpitäjät

Tämä kohta on valinnainen, ja sen olisi korvattava mahdolliset olemassa olevat erilliset ylläpitäjät.txt-tiedosto.

Advanced help

Advanced help näyttää ReadMe-tiedoston näytöllä, jos se on käytössä.

Kaikki Markdown

Aikana Drupal projekti on ainutkertainen, ei ole koskaan ollut selkeää yksimielisyyttä siitä, mikä on README-tiedoston pitäisi näyttää, ja monia eri tyylejä olemassa seurauksena (ks. linkit alla). Kuitenkin, me mieluummin uusia hankkeita käyttää muodossa kuvattu tällä sivulla, tai muodossa tunnustettu Markdown suodatin moduuli., Jos et käytä Markdown, tiedosto tulee nimetä README.md (ja käyttää voimassa Markdown syntaksi), muuten se olisi nimeltään README.txt.

Nopea alustus vinkkejä

Tässä on yhteenveto tiedostomuodossa README.txt:

• otsikot kaikissa caps.
• Otsikot alleviivattu ===/--- pituus otsikon, jota seuraa tyhjä rivi.
• kaksi riviä ennen otsikoita (paitsi ensimmäinen).
• tähdellä merkityt luodit ( * ), joissa on riippuvat luetelmakohdat.
• numeroidut listat sisennetyt 4 välilyöntiä.,
• Bulleted lists indented 1 space.
• teksti käsin word-kääritty noin 80 cols.

Näyte-lueminut-tiedosto

Jotkut näyte README-tiedostot:

• Morbus’ README.txt tyyli (joka vastaa Drupal core tyyli lähimpänä).
• helppo korppujauho README.md (joka käyttää tätä mallia)