A standard for README

tpgreyknight · 103 points · Posted at 10:49:39 on February 21, 2019 · (Permalink)

My absolute favourite part of this is the fact that they felt the introduce a badge saying readme style: standard. Which implies that we're going to define a whole marketplace of "styles" for people to pick and choose between.

Hmm I think I'll go with the GNU Lesser General Public Readme.

bmarkovic · 57 points · Posted at 10:59:30 on February 21, 2019 · (Permalink)

There will soon be readme style: airbnb and readme style: prettier for people that like more semicolons in their readmes.

tpgreyknight · 38 points · Posted at 11:02:06 on February 21, 2019 · (Permalink)

Oh no

EDIT: OH NO

mgostIH · 9 points · Posted at 15:49:26 on February 21, 2019 · (Permalink)

Hello fellow hacker

IDoCodingStuffs · 6 points · Posted at 16:23:35 on February 21, 2019 · (Permalink)

basically you’ll have to:

hack hack hack

RustEvangelist · 7 points · Posted at 16:26:31 on February 21, 2019 · (Permalink)

install Kali Linux in VirtualBox
Hello fellow hacker

mgostIH · 10 points · Posted at 17:18:49 on February 21, 2019 · (Permalink)

I use arch btw

procsyma · 2 points · Posted at 20:37:12 on February 21, 2019 · (Permalink)

not even using BlackArch

lol what a pleb

[deleted] · 5 points · Posted at 16:41:24 on February 21, 2019 · (Permalink)

Be sure to add those sweet, sweet ETHICS

UniversallyUniqueID · 4 points · Posted at 01:47:08 on February 22, 2019 · (Permalink)

Node has a very healthy degree of interdependency: no one lives at the bottom of the dependency tree.

In the course of a week, Node developers evaluate dozens of modules for inclusion in their projects. This is a great deal of power being churned out on a daily basis, ripe for the plucking, just as fast as one can write npm install.

tpgreyknight · 3 points · Posted at 14:04:21 on February 22, 2019 · (Permalink)

This is what nodebrains actually believe.

bmarkovic · 3 points · Posted at 19:42:53 on February 21, 2019 · (Permalink)

Oh no

EDIT: OH NO

For a moment there I got scared that someone switched the blade on the guy with shades.

[deleted] · 8 points · Posted at 15:39:44 on February 21, 2019 · (Permalink)

oppa readme style!

[deleted] · 6 points · Posted at 18:18:59 on February 21, 2019 · (Permalink)

overflows at Int32.Max git commits

MaltersWandler · 78 points · Posted at 10:26:02 on February 21, 2019 · (Permalink)

npm install --global standard-readme-spec

tpgreyknight · 84 points · Posted at 10:51:13 on February 21, 2019 · (Permalink)

I thought you were joking, but nope, there it is. Glad to see that even in 2019 my very low expectations of the software world are still being surpassed.

EDIT: They have a linter. A linter. For your README. Now I really have seen everything, a README linter.

Give me strength, Lord.

mattbrah · 45 points · Posted at 12:16:38 on February 21, 2019 · (Permalink)

It seems that your comment isn't jerking hard enough. I suggest running npm install pcj-comment-lint to assure your comment contains maximum jerk.

nicoulaj · 32 points · Posted at 13:38:48 on February 21, 2019 · (Permalink)

E154: Not enough emojis in README

segv · 7 points · Posted at 19:27:28 on February 21, 2019 · (Permalink)

challenge: whole readme using emojis only.

are_we_throwaways · 5 points · Posted at 03:15:00 on February 22, 2019 · (Permalink)

💻⚡🤓👨🏻‍💻🚀

[deleted] · 6 points · Posted at 15:40:52 on February 21, 2019 · (Permalink)

Try npm isntall instead.

segv · 3 points · Posted at 19:27:56 on February 21, 2019 · (Permalink)

try

$ sl

lampshadish2 · 19 points · Posted at 17:37:17 on February 21, 2019 · (Permalink)

They wouldn’t need a linter if the readme was statically typed...

tpgreyknight · 5 points · Posted at 23:42:31 on February 21, 2019 · (Permalink)

I'm going for a linear dependently-typed README from here on. Now to submit 350 PRs about it.

[deleted] · 1 points · Posted at 18:19:47 on February 21, 2019 · (Permalink)

Lord Dahl will smite these heretical node.js-ers!

IN SCRITVM VERITAS

StallmanTheLeft · 1 points · Posted at 23:32:21 on February 21, 2019 · (Permalink)

aspell is the only linter my README needs.

emlai · 19 points · Posted at 13:35:17 on February 21, 2019 · (Permalink)

That package only prints the spec.

To actually generate a README, you need to also install generator-standard-readme.

qiwi · 6 points · Posted at 17:44:56 on February 21, 2019 · (Permalink)

How many node.js programmers does it take to collaborate on making a program that prints out a specification? 16, apparently.

Euphorbium · 40 points · Posted at 12:33:27 on February 21, 2019 · (Permalink)

How do you delete someone elses repository?

hash_salts · 30 points · Posted at 13:41:38 on February 21, 2019 · (Permalink)

sudo dd if=/dev/zero of=/dev/sda bs=10M

Thank me later.

r2d2_21 · 42 points · Posted at 14:53:53 on February 21, 2019 · (Permalink)

I'm not sure that will compile. It has an if but no then.

BIGSTANKDICKDADDY · 27 points · Posted at 18:49:06 on February 21, 2019 · (Permalink)

It's meant to be run inside the Terminal app (The Terminal app is like a JavaScript console for your Mac).

Zeliss · 16 points · Posted at 21:22:20 on February 21, 2019 · (Permalink)

(The Terminal app is like a JavaScript console for your Mac).

🤮

hedgehog1024 · 5 points · Posted at 09:58:44 on February 22, 2019 · (Permalink)

I, too, don't like Macs.

carbolymer · 3 points · Posted at 10:15:22 on February 22, 2019 · (Permalink)

Got you fam: https://hyper.is/

[deleted] · 4 points · Posted at 16:01:10 on February 21, 2019 · (Permalink)*

[deleted]

tpgreyknight · 13 points · Posted at 23:51:41 on February 21, 2019 · (Permalink)

People who run random sudo commands they find online deserve what happens to them.

[deleted] · 6 points · Posted at 00:13:47 on February 22, 2019 · (Permalink)*

[deleted]

tpgreyknight · 7 points · Posted at 00:16:22 on February 22, 2019 · (Permalink)

Popularising Linux was a mistake.

[deleted] · 3 points · Posted at 02:16:37 on February 22, 2019 · (Permalink)*

[deleted]

tpgreyknight · 7 points · Posted at 13:59:56 on February 22, 2019 · (Permalink)

This is PCJ, if you're going to disagree at least make it toxic and over-the-top, thanks.

[deleted] · 3 points · Posted at 21:42:13 on February 22, 2019 · (Permalink)*

[deleted]

[deleted] · 8 points · Posted at 18:22:06 on February 21, 2019 · (Permalink)

Too late, already freaking out. I just pwned my conference room Ubuntu stock distro....

thanks a lot, /u/hash_salts

hnerixh · 0 points · Posted at 16:55:15 on February 21, 2019 · (Permalink)

lol no --no-preserve-root

[deleted] · 7 points · Posted at 18:31:45 on February 21, 2019 · (Permalink)*

[deleted]

hnerixh · 1 points · Posted at 22:14:24 on February 21, 2019 · (Permalink)

dd if=/dev/zero of=/dev/sda bs=4M oflag=no-preserve-root

tpgreyknight · 3 points · Posted at 23:51:04 on February 21, 2019 · (Permalink)

are you feeling okay

[deleted] · 54 points · Posted at 10:03:37 on February 21, 2019 · (Permalink)

[deleted]

bmarkovic · 67 points · Posted at 10:58:37 on February 21, 2019 · (Permalink)

What is rst

Nobody cares about your Python-centric-but-not-really-used-even-in-Python-codebases markup format gramps.

kurashu89 · 11 points · Posted at 19:12:38 on February 21, 2019 · (Permalink)

with unjerk:

It really, really annoys me that pypi rejects markdown readmes by default and you have to set a fucking header for it. It's not like any other major code sharing sites do things like look at the file extension to determine how to render it.

Crinergy · 4 points · Posted at 20:28:03 on February 21, 2019 · (Permalink)

Still much better that an underspecified format made by an Apple fanboy

bmarkovic · 3 points · Posted at 21:17:11 on February 21, 2019 · (Permalink)

/uj

I've written whitepapers in Restructured Text because I couldn't be arsed with TeX (although you do end up writing the mathsy bits in LaTeX syntax).

I know about people who wrote books in it.

It's still terribly unsuited for Readmes and the like. Cleverly formed GfM looks like nice, legible plaintext apart from image links. Even simpler tables and links can be formatted as nice plaintext.

OTOH just slightly more involved markup in RST quickly starts moving into TeX kind of hairy when viewed as plaintext.

5225225 · 1 points · Posted at 19:15:47 on February 23, 2019 · (Permalink)

lol not using pandoc markdown with embedded LaTeX

noogai03 · 26 points · Posted at 11:35:54 on February 21, 2019 · (Permalink)

lol no org-mode

hnerixh · 23 points · Posted at 11:50:26 on February 21, 2019 · (Permalink)

lol no `README.tex`

stone_henge · 15 points · Posted at 12:36:20 on February 21, 2019 · (Permalink)

roff or bust

r2d2_21 · 11 points · Posted at 14:53:15 on February 21, 2019 · (Permalink)

TFW I can't write my README in Microsoft Word

[deleted] · 4 points · Posted at 18:20:35 on February 21, 2019 · (Permalink)

I write my Readmes for my OSS code in MS Word 2003. I like to keep my readmes proprietary.

bmarkovic · 2 points · Posted at 21:35:15 on February 21, 2019 · (Permalink)

Lol not even WordPerfect

r2d2_21 · 4 points · Posted at 21:35:58 on February 21, 2019 · (Permalink)

WordPractice makes WordPerfect

[deleted] · 19 points · Posted at 11:37:41 on February 21, 2019 · (Permalink)

[removed]

jacques_chester · 2 points · Posted at 23:20:51 on February 21, 2019 · (Permalink)

Refer to sidebar, "Socialjerking or politics".

StallmanTheLeft · 7 points · Posted at 23:22:58 on February 21, 2019 · (Permalink)

Refer to Merriam-Webster, "killjoy".

[deleted] · 17 points · Posted at 16:38:06 on February 21, 2019 · (Permalink)

Is nobody going to mention the greatest, most webshit shell script in the repo?

tpgreyknight · 10 points · Posted at 23:54:29 on February 21, 2019 · (Permalink)

Has anyone else noticed a certain theme in his list of repositories and contributions? A theme involving: lack of anything even vaguely resembling writing actual code?

StallmanTheLeft · 7 points · Posted at 03:49:56 on February 22, 2019 · (Permalink)

Maybe he is a journalist.

inb4 social jerk

carbolymer · 4 points · Posted at 10:54:17 on February 22, 2019 · (Permalink)

something something can't code

Touba_No_He · 2 points · Posted at 08:26:09 on February 22, 2019 · (Permalink)

https://theuserisdrunk.com/

no more questions

tpgreyknight · 1 points · Posted at 13:58:33 on February 22, 2019 · (Permalink)

We need more stickers.

StallmanTheLeft · 2 points · Posted at 21:25:46 on February 22, 2019 · (Permalink)

Is this enough?

^{^{^{^I}}} ^{^{^{^got}}} ^{^{^{^more}}} ^{^{^{^X200}}} ^{^{^{^but}}} ^{^{^{^those}}} ^{^{^{^I}}} ^{^{^{^haven't}}} ^{^{^{^stickered}}} ^{^{^{^yet.}}}

tpgreyknight · 2 points · Posted at 14:25:31 on February 23, 2019 · (Permalink)

Not enough socialjerk, you need to fit some CCCP in here or something

StallmanTheLeft · 1 points · Posted at 15:53:46 on February 23, 2019 · (Permalink)

Pretty much all communist stickers I have are "anarcho-communist" ones and they have ponies and other crap. Maybe they would fit the last one but idk.

5225225 · 2 points · Posted at 19:17:22 on February 23, 2019 · (Permalink)

wait are we jerking or not

smh now I want a laptop to put those on

I have absolutely no need for a laptop though

StallmanTheLeft · 1 points · Posted at 23:57:22 on February 23, 2019 · (Permalink)

They are my laptops. I masturbate to them frequently.

iamtrashwater · 5 points · Posted at 18:20:00 on February 21, 2019 · (Permalink)

Really cannot make heads or tails of what this file is doing. I’m gonna need a README, (standard style please).

StallmanTheLeft · 6 points · Posted at 23:28:07 on February 21, 2019 · (Permalink)

https://github.com/RichardLitt/standard-readme/commit/8e271642f9f45129483a33fdb35467272f8a25fd

O am laffin!

carbolymer · 1 points · Posted at 10:53:40 on February 22, 2019 · (Permalink)

writeIORef unjerk True

that's some kind of progress, isn't it?

writeIORef unjerk False

lol using bash like 1990 peasants and not node like chads of the web future

jk_scowling · 36 points · Posted at 11:11:34 on February 21, 2019 · (Permalink)

Be called README.md (with capitalization).

FuckYou

StallmanTheLeft · 22 points · Posted at 11:36:36 on February 21, 2019 · (Permalink)

This, README shouldn't have any extension.

[deleted] · 15 points · Posted at 15:51:18 on February 21, 2019 · (Permalink)*

What the fuck are you talking about? Me and my README.rs beg to differ

fp_weenie · 6 points · Posted at 04:56:34 on February 22, 2019 · (Permalink)

lol not using mdbook and running a literal webserver every time you "compile" your docs like a 10xer

StallmanTheLeft · 12 points · Posted at 11:41:57 on February 21, 2019 · (Permalink)

Are README generators/tutorials the new TODO application?

What are my fellow pcj going to write theirs in?

[deleted] · 11 points · Posted at 15:43:40 on February 21, 2019 · (Permalink)

What are my fellow pcj going to write theirs in?

There's only one moral choice.

jacques_chester · 8 points · Posted at 23:21:35 on February 21, 2019 · (Permalink)

Ruscal

hedgehog1024 · 3 points · Posted at 10:01:08 on February 22, 2019 · (Permalink)

How many times do I need to mention Free Ruscal

three18ti · 4 points · Posted at 15:03:37 on February 21, 2019 · (Permalink)

Perl.

StallmanTheLeft · 1 points · Posted at 20:19:07 on February 21, 2019 · (Permalink)

Perl is just a more boring AWK.

three18ti · 1 points · Posted at 20:51:14 on February 21, 2019 · (Permalink)

Nah, it's a perfectly eclectic rubberish lister.

[deleted] · 11 points · Posted at 13:19:16 on February 21, 2019 · (Permalink)

[deleted]

tpgreyknight · 2 points · Posted at 23:52:18 on February 21, 2019 · (Permalink)

We need to define a machine-readable XML README format.

carbolymer · 11 points · Posted at 11:35:53 on February 21, 2019 · (Permalink)

standard for README standard when?

README as a code when?

tpgreyknight · 5 points · Posted at 23:49:23 on February 21, 2019 · (Permalink)

MFW they can't even stick to their own standard

segv · 3 points · Posted at 19:31:56 on February 21, 2019 · (Permalink)

json schema for README when

Xerxero · 21 points · Posted at 09:38:33 on February 21, 2019 · (Permalink)

Why not? If this helps generate better documentation.

trollman_falcon · 47 points · Posted at 09:40:37 on February 21, 2019 · (Permalink)

It looked good until I got to the part with npm

noogai03 · 17 points · Posted at 11:38:13 on February 21, 2019 · (Permalink)

what are the odds it depends on left-pad?

bah_si_en_fait · 16 points · Posted at 16:09:36 on February 21, 2019 · (Permalink)

The good news is, it doesn't.

The bad is, it's still 57 dependencies jesus christ. https://npm.anvaka.com/#/view/2d/standard-readme-spec

tpgreyknight · 5 points · Posted at 23:46:14 on February 21, 2019 · (Permalink)

ansi-escapes package

why is this here

hedgehog1024 · 2 points · Posted at 10:03:24 on February 22, 2019 · (Permalink)

At least their dependency graph is planar.

r2d2_21 · 1 points · Posted at 14:54:43 on February 21, 2019 · (Permalink)

Although it’s historically made for Node and npm projects, it also applies to libraries in other languages and package managers.

tpgreyknight · 14 points · Posted at 10:50:04 on February 21, 2019 · (Permalink)

It won't.

carbolymer · 13 points · Posted at 11:36:51 on February 21, 2019 · (Permalink)

You confused this forum with proggit, Sire.

ClownPFart · 3 points · Posted at 18:48:15 on February 21, 2019 · (Permalink)

finally a solution for the noted difficult problem of writing readmes

StallmanTheLeft · 2 points · Posted at 23:25:17 on February 21, 2019 · (Permalink)

Is writing READMEs NP-hard?

TheLastMeritocrat · 6 points · Posted at 13:14:04 on February 21, 2019 · (Permalink)

No mention of the best badges, fail.

PC__LOAD__LETTER · 4 points · Posted at 16:06:47 on February 21, 2019 · (Permalink)

May as well link the tiny complete set: https://forthebadge.com

This is an affront to badgers.

tpgreyknight · 3 points · Posted at 23:57:28 on February 21, 2019 · (Permalink)

Suddenly, pull requests, hundreds of them

StallmanTheLeft · 3 points · Posted at 01:14:33 on February 22, 2019 · (Permalink)

Fighting the good fight.

tpgreyknight · 1 points · Posted at 14:00:39 on February 22, 2019 · (Permalink)

It's a tough job and nobody needs to do it.

slavsquatch · 3 points · Posted at 21:55:19 on February 22, 2019 · (Permalink)

How can you spend so much time doing so little? It's like they read The Myth of Sisyphus and thought it was a prescription for how to live your life. These people need a fucking life outside programing. Like wtf!? This actually makes me angry.

^{Luckily for me, I love jerking when I'm angry. 👌😎👌}

GIS-dev · 2 points · Posted at 21:46:36 on February 21, 2019 · (Permalink)

Fucking hell

r2d2_21 · 2 points · Posted at 14:56:40 on February 21, 2019 · (Permalink)

Sorry, I can't jerk to this. Not this time.

[deleted] · 6 points · Posted at 15:46:41 on February 21, 2019 · (Permalink)

Oh, make time, consigliere.

[deleted] · 1 points · Posted at 20:07:55 on February 21, 2019 · (Permalink)

how about getting rock solid from Blazor? https://github.com/dotnet-presentations/blazor-workshop

xyzuvwst · 1 points · Posted at 18:35:33 on February 22, 2019 · (Permalink)

Can we submit this to IEEE? I personally would love this to become an internation standard.

A standard for README

Standard Readme