
***

# The README-Desktop-LIBrary project

<!-- Remove the parantheses in the title header for better readability !-->
  
![README_D1.png This image failed to load. It may be due to the file not being reached, or a general error. Reload the page to fix a possible general error.](/README_D1.png)

# By:

<!-- ![{Developer name} This image failed to load. It may be due to the file not being reached, or a general error. Reload the page to fix a possible general error.](/Image2.svg) !-->

## [Seanpm2001](https://github.com/seanpm2001/) / [README-Desktop-LIBrary](https://github.com/README-Desktop-LIBrary), Et; Al.
  
### Top

# `README.md`

***

## Read this article in a different language

_🌐 List of languages_

**Sorted by:** `A-Z`

[Sorting options unavailable](https://github.com/README-Desktop-LIBrary/README-Desktop-LIBrary.github.io/)

( [af Afrikaans](/.github/README_AF.md) Afrikaans | [sq Shqiptare](/.github/README_SQ.md) Albanian | [am አማርኛ](/.github/README_AM.md) Amharic | [ar عربى](/.github/README_AR.md) Arabic | [hy հայերեն](/.github/README_HY.md) Armenian | [az Azərbaycan dili](/.github/README_AZ.md) Azerbaijani | [eu Euskara](/.github/README_EU.md) Basque | [be Беларуская](/.github/README_BE.md) Belarusian | [bn বাংলা](/.github/README_BN.md) Bengali | [bs Bosanski](/.github/README_BS.md) Bosnian | [bg български](/.github/README_BG.md) Bulgarian | [ca Català](/.github/README_CA.md) Catalan | [ceb Sugbuanon](/.github/README_CEB.md) Cebuano | [ny Chichewa](/.github/README_NY.md) Chichewa | [zh-CN 简体中文](/.github/README_ZH-CN.md) Chinese (Simplified) | [zh-t 中國傳統的）](/.github/README_ZH-T.md) Chinese (Traditional) | [co Corsu](/.github/README_CO.md) Corsican | [hr Hrvatski](/.github/README_HR.md) Croatian | [cs čeština](/.github/README_CS.md) Czech | [da dansk](README_DA.md) Danish | [nl Nederlands](/.github/README_NL.md) Dutch | [**en-us English**](/.github/README.md) English |  [EO Esperanto](/.github/README_EO.md) Esperanto | [et Eestlane](/.github/README_ET.md) Estonian | [tl Pilipino](/.github/README_TL.md) Filipino | [fi Suomalainen](/.github/README_FI.md) Finnish |  [fr français](/.github/README_FR.md) French | [fy Frysk](/.github/README_FY.md) Frisian | [gl Galego](/.github/README_GL.md) Galician | [ka ქართველი](/.github/README_KA) Georgian | [de Deutsch](/.github/README_DE.md) German | [el Ελληνικά](/.github/README_EL.md) Greek | [gu ગુજરાતી](/.github/README_GU.md) Gujarati | [ht Kreyòl ayisyen](/.github/README_HT.md) Haitian Creole | [ha Hausa](/.github/README_HA.md) Hausa | [haw Ōlelo Hawaiʻi](/.github/README_HAW.md) Hawaiian | [he עִברִית](/.github/README_HE.md) Hebrew | [hi हिन्दी](/.github/README_HI.md) Hindi | [hmn Hmong](/.github/README_HMN.md) Hmong | [hu Magyar](/.github/README_HU.md) Hungarian | [is Íslenska](/.github/README_IS.md) Icelandic | [ig Igbo](/.github/README_IG.md) Igbo | [id bahasa Indonesia](/.github/README_ID.md) Icelandic | [ga Gaeilge](/.github/README_GA.md) Irish | [it Italiana/Italiano](/.github/README_IT.md) | [ja 日本語](/.github/README_JA.md) Japanese | [jw Wong jawa](/.github/README_JW.md) Javanese | [kn ಕನ್ನಡ](/.github/README_KN.md) Kannada | [kk Қазақ](/.github/README_KK.md) Kazakh | [km ខ្មែរ](/.github/README_KM.md) Khmer | [rw Kinyarwanda](/.github/README_RW.md) Kinyarwanda | [ko-south 韓國語](/.github/README_KO_SOUTH.md) Korean (South) | [ko-north 문화어](README_KO_NORTH.md) Korean (North) (NOT YET TRANSLATED) | [ku Kurdî](/.github/README_KU.md) Kurdish (Kurmanji) | [ky Кыргызча](/.github/README_KY.md) Kyrgyz | [lo ລາວ](/.github/README_LO.md) Lao | [la Latine](/.github/README_LA.md) Latin | [lt Lietuvis](/.github/README_LT.md) Lithuanian | [lb Lëtzebuergesch](/.github/README_LB.md) Luxembourgish | [mk Македонски](/.github/README_MK.md) Macedonian | [mg Malagasy](/.github/README_MG.md) Malagasy | [ms Bahasa Melayu](/.github/README_MS.md) Malay | [ml മലയാളം](/.github/README_ML.md) Malayalam | [mt Malti](/.github/README_MT.md) Maltese | [mi Maori](/.github/README_MI.md) Maori | [mr मराठी](/.github/README_MR.md) Marathi | [mn Монгол](/.github/README_MN.md) Mongolian | [my မြန်မာ](/.github/README_MY.md) Myanmar (Burmese) | [ne नेपाली](/.github/README_NE.md) Nepali | [no norsk](/.github/README_NO.md) Norwegian | [or ଓଡିଆ (ଓଡିଆ)](/.github/README_OR.md) Odia (Oriya) | [ps پښتو](/.github/README_PS.md) Pashto | [fa فارسی](/.github/README_FA.md) |Persian  [pl polski](/.github/README_PL.md) Polish | [pt português](/.github/README_PT.md) Portuguese | [pa ਪੰਜਾਬੀ](/.github/README_PA.md) Punjabi | No languages available that start with the letter Q | [ro Română](/.github/README_RO.md) Romanian | [ru русский](/.github/README_RU.md) Russian | [sm Faasamoa](/.github/README_SM.md) Samoan | [gd Gàidhlig na h-Alba](/.github/README_GD.md) Scots Gaelic | [sr Српски](/.github/README_SR.md) Serbian | [st Sesotho](/.github/README_ST.md) Sesotho | [sn Shona](/.github/README_SN.md) Shona | [sd سنڌي](/.github/README_SD.md) Sindhi | [si සිංහල](/.github/README_SI.md) Sinhala | [sk Slovák](/.github/README_SK.md) Slovak | [sl Slovenščina](/.github/README_SL.md) Slovenian | [so Soomaali](/.github/README_SO.md) Somali | [[es en español](/.github/README_ES.md) Spanish | [su Sundanis](/.github/README_SU.md) Sundanese | [sw Kiswahili](/.github/README_SW.md) Swahili | [sv Svenska](/.github/README_SV.md) Swedish | [tg Тоҷикӣ](/.github/README_TG.md) Tajik | [ta தமிழ்](/.github/README_TA.md) Tamil | [tt Татар](/.github/README_TT.md) Tatar | [te తెలుగు](/.github/README_TE.md) Telugu | [th ไทย](/.github/README_TH.md) Thai | [tr Türk](/.github/README_TR.md) Turkish | [tk Türkmenler](/.github/README_TK.md) Turkmen | [uk Український](/.github/README_UK.md) Ukrainian | [ur اردو](/.github/README_UR.md) Urdu | [ug ئۇيغۇر](/.github/README_UG.md) Uyghur | [uz O'zbek](/.github/README_UZ.md) Uzbek | [vi Tiếng Việt](/.github/README_VI.md) Vietnamese | [cy Cymraeg](/.github/README_CY.md) Welsh | [xh isiXhosa](/.github/README_XH.md) Xhosa | [yi יידיש](/.github/README_YI.md) Yiddish | [yo Yoruba](/.github/README_YO.md) Yoruba | [zu Zulu](/.github/README_ZU.md) Zulu ) Available in 110 languages (108 when not counting English and North Korean, as North Korean has not been translated yet [Read about it here](/OldVersions/Korean(North)/README.md))

Translations in languages other than English are machine translated and are not yet accurate. No errors have been fixed yet as of March 21st 2021. Please report translation errors [here](https://github.com/seanpm2001/README-Desktop-LIBrary/issues/). Make sure to backup your correction with sources and guide me, as I don't know languages other than English well (I plan on getting a translator eventually) please cite [wiktionary](https://en.wiktionary.org) and other sources in your report. Failing to do so will result in a rejection of the correction being published.

Note: due to limitations with GitHub's interpretation of markdown (and pretty much every other web-based interpretation of markdown) clicking these links will redirect you to a separate file on a separate page that isn't the intended page. You will be redirected to the [.github folder](/.github/) of this project, where the README translations are hosted.

Translations are currently done with Bing translate and DeepL. Support for Google Translate translations is coming to a close due to privacy concerns.

***

# Index

[00.0 - Top](#Top)

> [00.1 - Title](#The-README-Desktop-LIBrary-project)

> [00.2 - Read this article in a different language](#Read-this-article-in-a-different-language)

> [00.3 - Index](#Index)

[01.0 - Description](#README-Desktop-LIBrary)

[02.0 - About](#About)

[03.0 - History](#History)
  
> [03.1 - Pre-history](#Pre-history)

> [03.2 - Alpha History](#Alpha-history)

> [03.3 - Beta History](#Beta-history)

> [03.4 - Modern History](#Modern-history)

[04.0 - Wiki](#Wiki)

[05.0 - Copying](#Copying)

[06.0 - Credits](#Credits)

[07.0 - Authors](#Authors)

[08.0 - Installation](#Installation)

[09.0 - 404 page](#404-page)

[10.0 - Version history](#Version-history)

[11.0 - Software status](#Software-status)

[12.0 - Sponsor info](#Sponsor-info)

[13.0 - Contributers](#Contributers)

[14.0 - Issues](#Issues)

> [14.1 - Current issues](#Current-issues)

> [14.2 - Past issues](#Past-issues)

> [14.3 - Past pull requests](#Past-pull-requests)

> [14.4 - Active pull requests](#Active-pull-requests)

[15.0 - Resources](#Resources)

[16.0 - Contributing](#Contributing)

[17.0 - About README](#About-README)

[18.0 - README Version history](#README-version-history)

[19.0 - Technical notes](#Technical-notes)

[20.0 - Footer](#You-have-reached-the-end-of-the-README-file)

> [20.9 - End of file](#EOF)

***

# README_Desktop_LIBrary
A software library that natively renders README files in individual folders, just like GitHub, but on the Linux desktop. 

***

## About

See above. This project can apply a `README` preview to almost any portion of a program or directory. This was inspired by the functionality of `README.md` files on GitHub, and the idea was expanded upon so that `README` files could be placed anywhere and be customizable.

The use of capitalizing the first 3 letters of library (like so: LIBrary) was done to help people "learn through osmosis" and associate LIBRARY with the technical abbreviation of `LIB`

***
  
## History

This project has a short history so far.

### Pre-history

This project was started on 2021, Wednesday, June 9th at 8:27 pm to expand on the idea of a `README` file being previewed in more than 1 place, and for `README.md` previews to make their way to the Linux desktop.

### Alpha history

This project laid abandoned for a long time. On 2021 June 24th, this project received its own organization.

On 2021 September 7th, plans were prepared for getting the project up to date, as it has laid on the backburner for a long time. The next day, on Wednesday 2021 September 8th, the project was updated to modernize its elements, add some basic configuration, and add support for the idea of `README` previews anywhere. It also received its own website.

### Beta history

No Beta history to show for this project.

### Modern history

No Modern history to show for this project.

***

## Wiki

[Click/tap here to view this projects Wiki](https://github.com/README-Desktop-LIBrary/README-Desktop-LIBrary/wiki/)

If the project has been forked, the Wiki was likely removed. Luckily, I include an embedded version. You can view it [here](/External/ProjectWiki/).

***

## Copying

View the copying license for this project [here](/COPYING) (if you haven't built the project yet with the makefile, here is the original link: [COPYINGL](/COPYINGL)

Please note that you also have to follow the rules of the GNU General Public License v3 (GPL3) which you can view [here](/LICENSE.txt)

***

## Credits

View the credits file for this project and see the people who got together to make this project by [clicking/tapping here](/CREDITS)

***

## Authors

View the authors file for this project and see the authors of this project by [clicking/tapping here](/AUTHORS)

***

## Installation

View the installation instructions file for this project [here](/INSTALL)

Requirements: Jekyll, GitHub emulator (may not exist yet)

***

## 404 page

Test the 404 page for this project by [clicking/tapping here](/Site/404/THIS-WILL-NEVER-WORK/ABJAB/DXV48/22846/FILE.xabcdfgxlma329)

Getting a different 404 page? View the 404 page directly by [clicking/tapping here](/404.htm)

***

## Sponsor info

![SponsorButton.png](/SponsorButton.png)

You can sponsor this project if you like, but please specify what you want to donate to. [See the funds you can donate to here](https://github.com/seanpm2001/Sponsor-info/tree/main/For-sponsors/)

You can view other sponsor info [here](https://github.com/seanpm2001/Sponsor-info/)

Try it out! The sponsor button is right up next to the watch/unwatch button.

***

## Version history

**Version history currently unavailable**

**No other versions listed**

***

## Software status

All of my works are free some restrictions. DRM (**D**igital **R**estrictions **M**anagement) is not present in any of my works.

![DRM-free_label.en.svg](/DRM-free_label.en.svg)

This sticker is supported by the Free Software Foundation. I never intend to include DRM in my works.

I am using the abbreviation "Digital Restrictions Management" instead of the more known "Digital Rights Management" as the common way of addressing it is false, there are no rights with DRM. The spelling "Digital Restrictions Management" is more accurate, and is supported by [Richard M. Stallman (RMS)](https://en.wikipedia.org/wiki/Richard_Stallman/) and the [Free Software Foundation (FSF)](https://en.wikipedia.org/wiki/Free_Software_Foundation/)

This section is used to raise awareness for the problems with DRM, and also to protest it. DRM is defective by design and is a major threat to all computer users and software freedom.

Image credit: [defectivebydesign.org/drm-free/...](https://www.defectivebydesign.org/drm-free/how-to-use-label/)

***

## Contributers

Currently, I am the only contributer. Contributing is allowed, as long as you follow the rules of the [CONTRIBUTING.md](/CONTRIBUTING.md) file.

> * 1. [seanpm2001](https://github.com/seanpm2001/) - 46 commits (As of 2021, Wednesday, September 8th at 7:07 pm)

> * 2. No other contributers.

***

## Issues

### Current issues

* None at the moment

* No other current issues

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)

[Read the privacy policy on issue archival here](/.github/Issues/README.md)

**TL;DR**

I archive my own issues. Your issue won't be archived unless you request it to be archived.

### Past issues

* None at the moment

* No other past issues

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)

[Read the privacy policy on issue archival here](/.github/Issues/README.md)

**TL;DR**

I archive my own issues. Your issue won't be archived unless you request it to be archived.

### Past pull requests

* None at the moment

* No other past pull requests

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)

[Read the privacy policy on issue archival here](/.github/Issues/README.md)

**TL;DR**

I archive my own issues. Your issue won't be archived unless you request it to be archived.

### Active pull requests

* None at the moment

* No other active pull requests

If the repository has been forked, issues likely have been removed. Luckily I keep an archive of certain images [here](/.github/Issues/)

[Read the privacy policy on issue archival here](/.github/Issues/README.md)

**TL;DR**

I archive my own issues. Your issue won't be archived unless you request it to be archived.

***

## Resources

Here are some other resources for this project:

[Project language file A](/PROJECT_LANG_1.htm)

[View the editor configuration file for this project](/.editorconfig)

[View the linguist attributes file for this project](/.gitattributes)

[View the Git Ignore file for this project](/.gitignore)

[View the organization for this project](https://github.com/README-Desktop-LIBrary/)

[Build/view the makefile for this project](/makefile.mk)

[Join the discussion on GitHub](https://github.com/README-Desktop-LIBrary/README-Desktop-LIBrary/discussions/)

[View the issues/Raise an issue for this project](https://github.com/README-Desktop-LIBrary/README-Desktop-LIBrary/issues/)

No other resources at the moment.

***

## Contributing

Contributing is allowed for this project, as long as you follow the rules of the `CONTRIBUTING.md` file.

[Click/tap here to view the contributing rules for this project](/CONTRIBUTING.md)

***

## About README

**File type:** `Markdown document (*.md *.mkd *.markdown)`

**File version:** `1 (Wednesday, 2021, September 8th at 7:07 pm)`

**Line count:** `0,528`

***

## README version history

Version 0.1 (Sunday, March 21st 2021 at 7:50 pm)

> Changes:

> * Started the file

> * Added the title section

> * Added the index

> * Added the about section

> * Added the Wiki section

> * Added the version history section

> * Added the issues section.

> * Added the past issues section

> * Added the past pull requests section

> * Added the active pull requests section

> * Added the contributors section

> * Added the contributing section

> * Added the about README section

> * Added the README version history section

> * Added the resources section

> * Added a software status section, with a DRM free sticker and message

> * Added the sponsor info section

> * No other changes in version 0.1

Version 0.11 (Friday, July 16th 2021 at 9:20 pm)

> Changes:

> * Updated several sections with corrected template syntax

> * Added the history section

> * Updated the language list switcher section

> * Updated the file info section

> * Updated the file history section

> * No other changes in version 0.11

Version 0.11B (Friday, July 16th 2021 at 9:25 pm)

> Changes:
  
> * Fixed the footer, removed bad link (ddg.com does not redirect to duckduckgo)
  
> * Updated the file info section

> * Updated the file history section

> * No other changes in version 0.11B

Version 0.12A (Thursday, July 22nd 2021 at 6:26 pm)

> Changes:
  
> * The typo `SNU Erotica` was removed entirely

> * Added a better name than file.svg

> * Fixed the title section
  
> * Fixed the index
  
> > * Added the history section

> * Minor formatting fixes

> * Updated the file info section

> * Updated the file history section

> * No other changes in version 0.11B

Version 0.13 (2021, Saturday August 21st 2021 at 5:02 pm)

> Changes:
  
> * Times are now compliant with ISO:8601 and use YYYY-MM-DD rather than MM-DD-YYYY

> * Updated the title section

> * Fixed and update template links

> * Updated the index

> * Added the copying section

> * Added the credits section

> * Added the installation section

> * Added the 404 page test section

> * Updated the resources section

> * Updated the contributors section

> * Added the technical notes section

> * Updated the footer

> * Updated the file info section

> * Updated the file history section

> * No other changes in version 6 (0.13)

Version 0.14 (2021, Tuesday August 24th 2021 at 9:31 pm)

> Changes:
  
> * Times are now compliant with ISO:8601 and use YYYY-MM-DD rather than MM-DD-YYYY

> * Updated the index

> * Added the authors section

> * Updated the footer, adding support for the Swisscows search engine as a 4th option

> * Updated the file info section

> * Updated the file history section

> * No other changes in version 6 (0.13)

Version 1 (2021, Wednesday, September 8th at 7:07 pm)

> Changes:

> * Updated tag data

> * Updated the title section

> * Updated the history section

> * Updated the contributors section

> * Updated the footer, adding support for Safe.DuckDuckGo.com alongside DuckDuckGo.com

> * Updated the file info section

> * Updated the file history section

> * No other changes in version 1

Version 2 (Coming soon)

> Changes:

> * Coming soon

> * No other changes in version 2

***

## Technical notes

**All times are UTC-7 (PDT/Pacific Time)**

**The encoding is UTF-8 and is compatible with Unicode 5.0 and up**

***

## You have reached the end of the README file

( [Back to top](#Top) | [Exit to GitHub](https://github.com) | [Exit to Bing](https://www.bing.com/) | [Exit to DuckDuckGo](https://duckduckgo.com/) | [Exit to Safe.DuckDuckGo](https://safe.duckduckgo.com/) | [Exit to Ecosia](https://www.ecosia.org/) | [Exit to Swisscows](https://www.swisscows.com/) )

### EOF

***

