Idris2 icon indicating copy to clipboard operation
Idris2 copied to clipboard

refactor README and installation instructions

Open joelberkeley opened this issue 3 years ago • 2 comments

I've been looking at doing a good overhaul of the docs, to

  • make it easier for newcomers
  • reduce duplication

and wanted to get early feedback. Do be completely honest. Is this helpful? I have an idea to work on the docs much more widely, so the approach here (short, to the point) is as important as the content.

joelberkeley avatar Sep 19 '22 21:09 joelberkeley

I'm a bit cautious of changing the README, since it's the first thing people see on the repo. But generally, this looks okay. I've left some comments on the files : )

Indeed. That's why I want to get good feedback. I haven't made any attempt to be conservative in my changes.

(Minor nitpick: I'd keep the headings in present tense. They describe an action : ) )

they are in the present tense (Present simple rather than Present continuous). Is that OK?

joelberkeley avatar Sep 21 '22 12:09 joelberkeley

I'm a bit cautious of changing the README, since it's the first thing people see on the repo

btw this is precisely why I'm working on it - because it matters

joelberkeley avatar Sep 21 '22 13:09 joelberkeley

@CodingCellist I don't have the permissions to merge this, do you?

joelberkeley avatar Nov 15 '23 00:11 joelberkeley

I've got you

andrevidela avatar Nov 15 '23 00:11 andrevidela