[HN Gopher] Readme.so - Easiest Way to Create a Readme
___________________________________________________________________
Readme.so - Easiest Way to Create a Readme
Author : Garbage
Score : 208 points
Date : 2021-05-01 14:46 UTC (8 hours ago)
(HTM) web link (readme.so)
(TXT) w3m dump (readme.so)
| duxup wrote:
| I honestly was just thinking of rewriting a bunch of readmes at
| my workplace.
|
| Documentation is not our strong suit and I was wondering where to
| start with a good template that has some level of...
| professionalism / proven.
| jdorfman wrote:
| Saw this on Product Hunt. Can't wait to use it for my projects.
| Great work!
| podiki wrote:
| Nice! Would be great to have non md support as well (org
| especially, maybe .info, txt...).
| aparsons wrote:
| A VSCode extension (triggered on README.* files) that does this
| would be very nice to have
| ggrelet wrote:
| Is this related to vim.so and the knowledge content website
| creator slip.so?
| ilaksh wrote:
| To me the biggest thing is that I don't make a lot of tables in
| markdown so being able to drag and drop that would be easier than
| looking it up. Although having a list of potential sections is
| helpful too.
|
| I am wondering if there is something like a snippet database
| plugin for any text editor that would allow you to easily look
| things up without googling into Stack Overflow. Or maybe it would
| literally do that behind the scenes.
|
| Because there are so many times where you just need a short
| example of how to use something so you get the syntax and core
| parameters or whatever right. Even for basic things like making a
| table in markdown. Which I think uses the pipe bar and hyphens
| but not sure.
| samstave wrote:
| This looks really good!
|
| I second .md support.
|
| Can you please give a page-wide dark-mode option, and even each
| section?
| hvocode wrote:
| This would be useful as part of the new repo creation workflow on
| GitHub too. Instead of just getting an empty readme, pick the
| sections you want and start with one that just needs to be filled
| in. Could autopopulate some sections too (eg, license). I'd
| rather that so I can edit in my regular editor without having to
| use a separate site and web editor to get that initial template.
| foolinaround wrote:
| Nice!
|
| - It should also be able to generate a pdf on demand
|
| - It should have support for asciidoc (generate output in it)
| _kst_ wrote:
| My first thought was to wonder why I'd want a README in a shared
| object.
| arey_abhishek wrote:
| Great work! The editor is simple enough that it works. Even using
| the left sidebar as a checklist of items to include in a readme
| makes this useful.
| doublerabbit wrote:
| > This site is optimized for desktop Please visit readme.so on a
| desktop to create your readme!
|
| So it's not the easiest way to create a readme.
| capableweb wrote:
| I guess if you normally create your READMEs on the phone, then
| no. But then, how often do you create READMEs on a phone? I can
| count on no hands the amount of times I've done that in my
| life.
| oneeyedpigeon wrote:
| I'm also on mobile. No, I've probably never had a need to
| create a README from my phone, but it would be useful to be
| able to learn about this service. I wonder what they're doing
| that's so complicated it doesn't work on mobile...
| katherinecodes wrote:
| The mobile version is in progress. The layout doesn't quite
| work on mobile, and the editor library I used doesn't work
| on mobile, so it requires some tweaks.
|
| The reason it's not done yet is because I have a job and
| this is a side project :)
| slenk wrote:
| Visit on a website and you will see, it needs widescreen.
|
| Maybe flip your phone horizontal and request desktop site?
| podiki wrote:
| Could just be the view/layout? What about forcing desktop
| version on mobile browser?
| [deleted]
| gkoberger wrote:
| As the founder of a quite similarly named company, this looks
| great :) Not sure if you're looking for a job Katherine, but if
| you are my email is in my profile!
| parhamn wrote:
| This felt genuine. But I must admit, asking someone launching
| something if they're looking for a job rubbed me the wrong way.
| :shrug:
| togaen wrote:
| Why is this easier than opening a text editor?
| bauerd wrote:
| It is not about opening a text editor. It's about what you
| would type into that editor. The value provided is in the
| templates, not in the editor.
| system2 wrote:
| If someone is writing readmes all the time, why wouldn't that
| person have a pandadoc or similar template for this task?
| Phil-bitplex wrote:
| You're exactly right - if you're writing readme's all the
| time, you'd have templates ready to go.
|
| I only write readme's maybe once every few months or
| perhaps once a year, and having a template (interactive
| like this one, or otherwise) that someone else has thought
| about is super useful to me.
| max-ibel wrote:
| Actually, I'd love an emacs extension for that use case. There
| probably are 12 already, a few within org mode ...
| [deleted]
| sdesol wrote:
| By all early metrics, this project looks like it can become
| extremely popular and healthy. If you switch to the impact view
| in the following:
|
| https://public-001.gitsense.com/insights/github/repos?q=wind...
|
| And look at the impact chart at the bottom, it has all the signs
| of a healthy/popular project. A high number of contributors in
| Zone 3 indicates strong interest. A decent number of contributors
| in Zone 2, indicates high individual contributions to the
| project. And having no contributors in Zone 1 is the most
| important, as it means the work is being fairly distributed among
| Zone 2 contributors.
|
| Normally for a project to be this fresh (23 days), you would
| expect somebody in Zone 1, but there isn't any, which is a very
| strong indicator of popularity and an even distribution of work
| that should make it more viable in the long run.
|
| Note: Don't install my tool as the license in the docker image is
| out of date and needs to be updated.
|
| Edit: Any reason for the downvoting? I know it is my tool but it
| does show insights that is relevant to the repository.
| tracer4201 wrote:
| Hey this is a pretty cool project. Nice job.
|
| One of my struggles at work has been inheriting some code base
| from whichever team that has no documentation or it's not even
| clear why something was built in the first place. Sometimes we're
| left scratching our heads -- "how do I even build this thing?"
|
| I'm a strong believer in a concise Readme file.
| treeman79 wrote:
| Someone once told me, assume the person after that is easily
| annoyed enjoys hunting people and knows where you live.
|
| After having to take a number of abandoned but important
| projects. I can fully appreciate both sides.
| jitl wrote:
| Watch out, the .so domain presents a lot of headaches
| fnord77 wrote:
| libgc.so :D
| tediousdemise wrote:
| glibc?
| airstrike wrote:
| Sadly, read.me is not available
| toper-centage wrote:
| Like what?
| st_goliath wrote:
| Some years back, I used to be the proud owner of
| "libgoliath.so", but then they suddenly decided to hike the
| price to IIRC Euro 80,- per year (either that, or prove that
| I have a Somalian citicenship). So I dropped that.
|
| So now I'm the proud owner of "goliath32.com", which I
| currently keep parked until I finally, hopefully get around
| to overhauling my 10 year old personal site.
| vanderZwan wrote:
| "Price hike", really? I would not exactly call 6.67 euros a
| month a rip-off. Given your reaction to it, it seems like a
| very reasonable policy to ensure that people claiming a URL
| really have plans with it, while keeping out foreigners
| parking on Somalian webpace for the lulz.
|
| EDIT: some context that is probably relevant to this topic
| that I should not presume to be familiar with everyone is
| the controversy surrounding .io domains:
|
| https://gigaom.com/2014/06/30/the-dark-side-of-io-how-
| the-u-...
| st_goliath wrote:
| I'm old enough to remember personal websites being a
| thing, before everyone and their company went over on
| that Face Site. I had a personal site back than which
| IIRC 2010 or 2011-ish I moved to the domain I mentioned,
| and, at the time, I kept updating the site somewhat
| regularly (before than I had a .de domain, which was
| really darn cheap and the site was in German only).
|
| The .so NIC "adjusted" the price IIRC around 2014 or so.
|
| Most of the domains I have, or ever had, cost somewhere <
| 20 Euro per year. Whether this is a reasonable price for
| occupying less than 100 bytes in someones database (among
| tons of others, paying for that privilege) is debatable,
| but is IMO ok-ish.
|
| When it gets closer to Euro 100,- per year (IIRC!) it
| does start to get painful and I start thinking if that is
| really worth paying out of my own pocket for my spare
| time stuff that people nowadays may not even look at at
| all. At that point I start thinking "I'd rather have a
| tilde-directory some place and eat a couple Pizzas a year
| for the money instead".
|
| I migrated that stuff to goliath32.com and, after I
| simply ran out of time/enthusiasm to maintain a blog, I
| eventually decided to split the software projects up to a
| separate, more professional looking place, under
| "infraroot.at" (a TLD in the country where _I live_ ). As
| I said, I still want to get my act together on the
| personal stuff and eventually bring the goliath32.com
| back to live, which I have currently shelved since the
| interesting stuff was moved elsewhere.
|
| Politics and country matters are something to keep in
| mind, of course, when you get yourself a fancy two-letter
| TLD (thanks for pointing out the .io controversy), but
| please don't try to spin a glorified database entry for
| which I'm not willing to pay for through my nose into
| some kind of ad-hominem attack.
| alisonkisk wrote:
| If the price is too high, you can lodge a complaint with
| your elected representatives in Somalia, or you can use a
| domain in your home country.
| st_goliath wrote:
| Choosing any price or deciding to boot non-citizens is
| their perfect right. Heck, I would even be in favor of
| country code TLDs only being used for stuff somehow
| related to those countries. _I never claimed anything
| else_ , I just tried to point this out, because someone
| asked (see several postings up).
|
| I'm not running some kind of startup. Outside my work I'm
| just some guy tinkering with electronics, software and
| network stuff, and sometimes I write about it on the Web,
| so naturally I would like to have a catchy domain name
| with _my IRC and IRL nick name in it_ that people know my
| by. I went with the .so domain, because it made for a
| nice play on words, same for the .com domain. Why do I
| have to justify that all of the sudden?
|
| > or you can use a domain in your home country.
|
| For some of my more involved software projects, that's
| exactly what I did. It says so _right in the post you
| replied to_.
| vanderZwan wrote:
| There's nothing ad-hominem in my response, I just
| question your assessment that 80 euros a year is forcing
| you to "pay through the nose".
|
| Describing these events the way you do makes it sound as
| if you're being blackmailed or something. You're not. The
| Somalian government have the right to handle the _.so_
| domains however they please. If they demand that people
| are either Somali or otherwise pay a fee of 80 euros,
| there is nothing inherently wrong with that. If you find
| that an unreasonable price, go elsewhere. Nobody is
| forcing you to buy the domain. Which, as far as I can
| tell, is what you did.
|
| Basically, what I don't understand is why you describe
| the event in a way that makes it sound as if they denied
| you something that you were entitled to when that was not
| the case.
| [deleted]
| config_yml wrote:
| https://twitter.com/wesbos/status/1360246445341818882
| breakfastduck wrote:
| Apparently a nightmare to renew. It is a somalian domain name
| after all. I don't understand why its so trendy.
|
| Notion went down a few months ago due to issues with their
| .so domain and they said they're planning to move.
| capableweb wrote:
| notion.com redirects to notion.so, so they already own that
| domain too.
___________________________________________________________________
(page generated 2021-05-01 23:00 UTC)