* . *
  • About
  • Advertise
  • Privacy & Policy
  • Contact
Sunday, June 7, 2026
Earth-News
  • Home
  • Business
  • Entertainment

    Introducing the 2026-2027 Debutantes: A Dazzling New Circle Revealed

    Blue Fox Entertainment Revitalizes iPic Theaters in Westwood and New York with Exciting Relaunch as The Cinemas

    How Online Casinos Have Revolutionized Digital Entertainment

    10 Must-Watch Shows for Fans of ‘Spider-Noir

    Scott Pelley fired from ’60 Minutes,’ deepening turmoil at CBS News – Idaho State Journal

    Why Max Cady from ‘Cape Fear’ Continues to Haunt Audiences as a Timeless Nightmare

  • General
  • Health
  • News

    Cracking the Code: Why China’s Economic Challenges Aren’t Shaking Markets, Unlike America’s” – Bloomberg

    Trump’s Narrow Window to Spread the Truth About Harris

    Trump’s Narrow Window to Spread the Truth About Harris

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Trending Tags

    • Trump Inauguration
    • United Stated
    • White House
    • Market Stories
    • Election Results
  • Science
  • Sports
  • Technology

    Dr. Matthew Willsey: Revolutionizing Healthcare Innovation in Detroit

    Syracuse Central High School Junior-Senior Prom 2026: An Unforgettable Night of Celebration

    Teradata Bridges Data, AI, and Tech Roles to Drive Execution Success Amid Investor Focus

    How Technology Is Revolutionizing the Future of the Restaurant Industry

    Innovative Chemical “Cage” Strategy Enables Precise Drug Delivery and Activation

    China has approved the world’s first invasive brain-computer chip—here’s what’s next – MIT Technology Review

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
  • Home
  • Business
  • Entertainment

    Introducing the 2026-2027 Debutantes: A Dazzling New Circle Revealed

    Blue Fox Entertainment Revitalizes iPic Theaters in Westwood and New York with Exciting Relaunch as The Cinemas

    How Online Casinos Have Revolutionized Digital Entertainment

    10 Must-Watch Shows for Fans of ‘Spider-Noir

    Scott Pelley fired from ’60 Minutes,’ deepening turmoil at CBS News – Idaho State Journal

    Why Max Cady from ‘Cape Fear’ Continues to Haunt Audiences as a Timeless Nightmare

  • General
  • Health
  • News

    Cracking the Code: Why China’s Economic Challenges Aren’t Shaking Markets, Unlike America’s” – Bloomberg

    Trump’s Narrow Window to Spread the Truth About Harris

    Trump’s Narrow Window to Spread the Truth About Harris

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    Israel-Gaza war live updates: Hamas leader Ismail Haniyeh assassinated in Iran, group says

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    PAP Boss to Niger Delta Youths, Stay Away from the Protest

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Court Restricts Protests In Lagos To Freedom, Peace Park

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Fans React to Jazz Jennings’ Inspiring Weight Loss Journey

    Trending Tags

    • Trump Inauguration
    • United Stated
    • White House
    • Market Stories
    • Election Results
  • Science
  • Sports
  • Technology

    Dr. Matthew Willsey: Revolutionizing Healthcare Innovation in Detroit

    Syracuse Central High School Junior-Senior Prom 2026: An Unforgettable Night of Celebration

    Teradata Bridges Data, AI, and Tech Roles to Drive Execution Success Amid Investor Focus

    How Technology Is Revolutionizing the Future of the Restaurant Industry

    Innovative Chemical “Cage” Strategy Enables Precise Drug Delivery and Activation

    China has approved the world’s first invasive brain-computer chip—here’s what’s next – MIT Technology Review

    Trending Tags

    • Nintendo Switch
    • CES 2017
    • Playstation 4 Pro
    • Mark Zuckerberg
No Result
View All Result
Earth-News
No Result
View All Result
Home Technology

Why Is README Capitalized? (2015)

April 11, 2024
in Technology
Why Is README Capitalized? (2015)
Share on FacebookShare on Twitter

All-uppercase letters stand out and make the file easily visible which makes sense because it is probably the first thing a new user would want to look at. (Or, at least, should have looked at…) As others have already said, file names starting with a capital letter will be listed before lower-case names in ASCIIbetical sorting (LC_COLLATE=C) which helps make the file visible at a first glance.

The README file is part of a bunch of files a user of a free software package would normally expect to find. Others are INSTALL (instructions for building and installing the software), AUTHORS (list of contributors), COPYING (license text), HACKING (how to get started for contributing, maybe including a TODO list of starting points), NEWS (recent changes) or ChangeLog (mostly redundant with version control systems).

This is what the GNU Coding Standards have to say about the README file.

The distribution should contain a file named README with a general overview of the package:

the name of the package;
the version number of the package, or refer to where in the package the version can be found;
a general description of what the package does;
a reference to the file INSTALL, which should in turn contain an explanation of the installation procedure;
a brief explanation of any unusual top-level directories or files, or other hints for readers to find their way around the source;
a reference to the file which contains the copying conditions. The GNU GPL, if used, should be in a file called COPYING. If the GNU LGPL is used, it should be in a file called COPYING.LESSER.

Since it is always good to strive for the least surprise of your users, you should follow this convention unless there are compelling reasons for a deviation. In the UNIX world, file name extensions were traditionally used sparingly so the canonical name of the file is README without any suffix. But most users probably would have no troubles understanding that a file named README.txt has the same meaning. If the file is written in Markdown, a file name like README.md might also be reasonable. Avoid using more complicated markup languages like HTML in the README file, however, because it should be convenient to read on a text-only terminal. You can point users to the manual of the software or its on-line documentation, that might be written in a more sophisticated format, for details from the README file.

>>> Read full article>>>
Copyright for syndicated content belongs to the linked Source : Hacker News – https://softwareengineering.stackexchange.com/questions/301691/readme-txt-vs-readme-txt

Tags: CapitalizedREADMEtechnology
Previous Post

Show HN: I made a new sensor out of 3D printer filament for my PhD

Next Post

Vortex: OpenCL Compatible RISC-V Gpgpu

Dr. Matthew Willsey: Revolutionizing Healthcare Innovation in Detroit

June 6, 2026

9 Captivating Books That Dive Into the World of Queer Ecology

June 6, 2026

Kimi Antonelli’s dominance continues as he beats Max Verstappen for Monaco Grand Prix pole position – Yahoo Sports

June 6, 2026

Museum Of Illusions Denver: Inside Denver’s Museum Of Illusions: Mind-Bending Science And Fun – Fox Rio Grande Valley

June 6, 2026

Blazing Heat Waves Ignite Aggression and Impair Animal Thinking

June 6, 2026

Kent Reform Councillor Sparks Controversy by Comparing IVF to Cosmetic Surgery and Other Lifestyle Choices

June 6, 2026

Pope Leo XIV and I Agree: Our Country and World Are in Urgent Need of Healing

June 6, 2026

U.S. Economy Surges Forward with 172,000 New Jobs Added in May

June 6, 2026

NC State Health Plan Board Approves Higher Costs for Some Retirees Starting in 2027

June 6, 2026

Introducing the 2026-2027 Debutantes: A Dazzling New Circle Revealed

June 6, 2026

Categories

Archives

June 2026
M T W T F S S
1234567
891011121314
15161718192021
22232425262728
2930  
« May    
Earth-News.info

The Earth News is an independent English-language daily published Website from all around the World News

Browse by Category

  • Business (20,132)
  • Ecology (1,252)
  • Economy (1,274)
  • Entertainment (22,150)
  • General (21,938)
  • Health (10,308)
  • Lifestyle (1,285)
  • News (22,149)
  • People (1,276)
  • Politics (1,293)
  • Science (16,488)
  • Sports (21,772)
  • Technology (16,259)
  • World (1,265)

Recent News

Dr. Matthew Willsey: Revolutionizing Healthcare Innovation in Detroit

June 6, 2026

9 Captivating Books That Dive Into the World of Queer Ecology

June 6, 2026
  • About
  • Advertise
  • Privacy & Policy
  • Contact

© 2023 earth-news.info

No Result
View All Result

© 2023 earth-news.info

No Result
View All Result

© 2023 earth-news.info

Go to mobile version