SQL ERROR: query=( SELECT 'common' AS book_type, pbs.book_section_id, pbs.snippet, b.id AS book_id, b.name AS book_name, b.year AS book_year, b.series AS book_series, b.link as book_link, b.litres_link, ba.id AS author_id, ba.name AS author_name, ba.link as author_link, bst.pid as pid, bs.link as section_link FROM kartaslov.phrases p JOIN kartaslov.phrase_book_section pbs ON pbs.phrase_id = p.id AND pbs.book_type = 'common' JOIN kartaslov.books b ON b.id = pbs.book_id JOIN kartaslov.book_authors ba ON ba.id = b.author_id JOIN kartaslov.book_section_text bst ON bst.id = pbs.book_section_text_id JOIN kartaslov.book_sections bs ON bs.id = bst.book_section_id WHERE p.phrase = ? LIMIT 0, 3 ) UNION ALL ( SELECT 'classic' AS book_type, pbs.book_section_id, pbs.snippet, cb.id AS book_id, cb.name AS book_name, cb.year AS book_year, cb.series AS book_series, cb.link as book_link, NULL AS litres_link, cba.id AS author_id, cba.name AS author_name, cba.link AS author_link, cbst.pid as pid, cbs.link as section_link FROM kartaslov.phrases p JOIN kartaslov.phrase_book_section pbs ON pbs.phrase_id = p.id AND pbs.book_type = 'classic' JOIN kartaslov.classic_books cb ON cb.id = pbs.book_id JOIN kartaslov.classic_book_authors cba ON cba.id = cb.author_id JOIN kartaslov.classic_book_section_text cbst ON cbst.id = pbs.book_section_text_id JOIN kartaslov.classic_book_sections cbs ON cbs.id = cbst.book_section_id WHERE p.phrase = ? LIMIT 0, 3 ); err=Unknown column 'pbs.book_section_id' in 'SELECT' SQL_ERR
Dokument või fail, mis sisaldab teavet teise faili, kataloogi või programmi kohta, selgitades sageli, kuidas seda kasutada.
| positsioon | Domeen | Lehekülg | Tegevused |
|---|---|---|---|
| 1 | readme.com | / | |
|
Täielik URL
Pealkiri
ReadMe
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
ReadMe makes it easy to create and publish beautiful, interactive API documentation. Whether you want to work in our WYSIWYG editor or check-in your docs as ... |
|||
| 2 | docs.github.com | /ru/repositories/man... | |
|
Pealkiri
О файлах README - Документация по GitHub;20991931
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Файл README должен содержать только ту информацию, которая необходима разработчикам , чтобы приступить к использованию проекта и внести свой вклад в проект. |
|||
| 3 | ru.wikipedia.org | /wiki/readme-%d1%84%... | |
|
Pealkiri
README-файл
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
README (от англ. "read me"— прочти меня) — текстовый файл, который распространяется вместе с программным обеспечением и содержит информацию о нём. |
|||
| 4 | habr.com | /ru/articles/810537/ | |
|
Täielik URL
Pealkiri
Искусство README / Хабр;30243547
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
26 апр. 2024 г. — README – это первый и, возможно, единственный взгляд потребителя модуля на ваше творение. Пользователям нужен модуль, чтобы удовлетворить его ... |
|||
| 5 | doka.guide | /recipes/github-add-... | |
|
Täielik URL
Pealkiri
Как написать README на GitHub — Рецепты
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Решение · название продукта; · краткое описание; · основные возможности; · инструкция по установке и/или подключению; · инструкция по запуску в режиме ... |
|||
| 6 | www.makeareadme.com | / | |
|
Täielik URL
Pealkiri
Make a README
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
A README is a text file that introduces and explains a project . It contains information that is commonly required to understand what the project is about. |
|||
| 7 | learn.microsoft.com | /ru-ru/nuget/nuget-o... | |
|
Pealkiri
Файл README пакета на NuGet.org;39088322
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
12 мая 2025 г. — Включите файл readme в пакет NuGet , чтобы сделать сведения о пакете более подробными и более информативными для пользователей! |
|||
| 8 | docs.gitflic.ru | /company/readme/;227... | |
|
Täielik URL
Pealkiri
Readme компании
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Создание README компании · Создайте публичный проект, который будет иметь URL, совпадающий с URL вашей компании в GitFlic . · Склонируйте или создайте удаленное ...;52880964 |
|||
| 9 | github.com | /GnuriaN/format-READ... | |
|
Täielik URL
Pealkiri
GnuriaN/format-README
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Для описания проектов на GitHub используется README.md , который пишется на языке разметки markdown. Что и как поддерживается расписано ниже. |
|||
| positsioon | Domeen | Lehekülg | Tegevused |
|---|---|---|---|
| 1 | readme.ru | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 2 | ru.wikipedia.org | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 3 | en.wikipedia.org | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 4 | itunes.apple.com | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 5 | video.qip.ru | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 6 | code.google.com | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 7 | webpark.ru | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 8 | tes.ag.ru | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 9 | media-online.ru | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
| 10 | twitter.com | / | |
|
Täielik URL
Pealkiri
Ei kehti
Viimati värskendatud
Ei kehti
Lehe autoriteet
Ei kehti
Liiklus:
Ei kehti
Tagasilingid:
Ei kehti
Sotsiaalsed jagamised:
Ei kehti
Laadimisaeg:
Ei kehti
Lõigu eelvaade:
Väljavõte pole saadaval |
|||
Tere tulemast avatud lähtekoodiga projektide, kodeerimishoidlate ja koostööpõhise tarkvaraarenduse maailma. Kui olete selles ruumis uus või alles täiendate oma oskusi, olete tõenäoliselt komistanud termini otsa, mis sageli esile kerkib: LOE.
See pealtnäha lihtne dokument on iga hoidla nurgakivi, toimides lüüsina looja ja kasutaja vahel. Selles artiklis käsitleme põhjalikult, mis on README-fail, miks see on oluline, kuidas seda kirjutada ja kuidas seda nii professionaalsetes kui ka isiklikes projektides maksimaalselt ära kasutada.
README-fail, tavaliselt nimega "README.md" või lihtsalt "README", toimib projekti sissejuhatuse ja juhendina. See on esimene asi, mida kasutajad uut hoidlat uurides näevad, ja selle kvaliteet võib oluliselt mõjutada nende ettekujutust ja projektiga seotust.
Hästi läbimõeldud README võib teie projekti edukust oluliselt mõjutada. Siin on mõned põhjused, miks see nii oluline on:
Suurepärase README loomine nõuab hoolikat planeerimist ja tähelepanu detailidele. Järgige neid näpunäiteid, et koostada dokument, mis teie projekti hästi teeniks:
Püüdke saavutada lühidust ilma selgust ohverdamata. Kasutajad peaksid saama teie projekti olemusest aru mõne minutiga. Kasutage teksti tükeldamiseks ja skannitavaks muutmiseks alampealkirju, täppe ja lühikesi lõike.
Enamik README-faile on kirjutatud Markdownis, kerges märgistuskeeles, mis võimaldab teil teksti hõlpsalt vormindada. Visuaalselt atraktiivse ja loetava dokumendi loomiseks tutvuge Markdowni põhisüntaksiga, nagu päised, loendid, rõhuasetused, lingid ja pildid.
Lisage põhifunktsioonide ja kasutusstsenaariumide illustreerimiseks visuaalseid elemente. Ekraanipildid, diagrammid ja koodilõigud võivad aidata kasutajatel mõista, kuidas projekt töötab ja kuidas nad sellest kasu saavad.
LUGEMISMÕISTLUS on väärtuslik ainult siis, kui see sisaldab täpset ja asjakohast teavet. Muutke harjumuseks dokumenti värskendada, kui teete projektis olulisi muudatusi, näiteks lisate uusi funktsioone, parandate vigu või muudate installiprotseduure.
Arvestage kõigi potentsiaalsete kasutajate, sealhulgas puuetega kasutajate vajadustega. Kasutage piltide jaoks selget keelt, kirjeldavat alternatiivteksti ning veenduge, et teie dokumendis oleks ekraanilugejate ja muude abitehnoloogiate jaoks lihtne navigeerida.
Selleks, et teid veelgi inspireerida, on siin mõned README-de näited, mis näitavad parimaid tavasid.
Kui olete loonud suurepärase README, on oluline seda ajakohasena hoida ja selle kvaliteeti aja jooksul säilitada. Siin on mõned näpunäited, mis aitavad teil seda teha:
Tarkvara arendamise jätkudes muutub ka README-failide roll. Kuigi traditsioonilised Markdowni dokumendid jäävad standardiks, näeme kasvavat huvi alternatiivsete vormingute ja tööriistade vastu, mis täiustavad README kogemust.
Üks näide on README.mdx, mis laiendab Markdowni JSX-i süntaksiga, võimaldades arendajatel lisada oma dokumentatsiooni interaktiivseid elemente ja dünaamilist sisu. Teised esilekerkivad trendid hõlmavad AI-toega README generaatoreid, mis loovad koodianalüüsi ja kasutajate tagasiside põhjal automaatselt dokumentatsiooni.
Kuigi need uued arengud on põnevad, jäävad tõhusa README-kirjutamise põhiprintsiibid samaks: selgus, kokkuvõtlikkus ja juurdepääsetavus. Olles kursis valdkonna suundumuste ja parimate tavadega, saate tagada, et README jääb teie projekti ja selle kasutajate jaoks väärtuslikuks ressursiks.
Kokkuvõttes on README-fail iga tarkvaraprojekti kriitiline komponent, toimides sillana loojate ja kasutajate vahel. Mõistes selle eesmärki, järgides selle kirjutamise ja hooldamise parimaid tavasid ning olles kursis valdkonna trendidega, saate luua README, mis parandab kasutajakogemust ja aitab kaasa teie projekti edule.
Pidage meeles, et suurepärane README ei ole lihtsalt dokument – see on vestluse alustaja, probleemide lahendaja ja värav koostööle. Nii et järgmine kord, kui töötate projekti kallal, võtke aega, et koostada README, mis peegeldaks tõeliselt teie töö väärtust ja potentsiaali.
Head kodeerimist!
Selle artikli kirjutas serpulse.com.