search

TransitionbyDesign / homemaker

GNU Affero General Public License v3.0
0 stars 1 forks source link

Review README.md and update as necessary #70

Open wu-lee opened 3 years ago

wu-lee commented 3 years ago

See https://github.com/TransitionbyDesign/homemaker/blob/master/README.md

wu-lee commented 3 years ago

@Charlie-TbD @JasLewicki - please also check you can edit the README document, which serves as a landing page for the project. There's a an "edit" icon on the github page top right. You should be able to edit all the content in this repository this way, as a lower-level but more comprehensive alternative to forestry.io. The site should then rebuild automatically (so long as it is the master branch being altered.) Forestry.io should adapt accordingly.

Charlie-TbD commented 3 years ago

Struggling with this - I can see the file you link to but the Edit icon just edits that readme text. Could do with talking through what I'm supposed to do with it if possible.

wu-lee commented 3 years ago

There should be a pencil icon, which indeed does allow you to edit the text of the README.

All I mean is, if you want to keep any useful information, links, documentation, or whatever, associated and versioned with the code in this project where all can easily find it, that'd be the place for it.

My other point just means, all the files in this repository can be edited this way, so in a pinch you may be able to fix simple things yourself, like wording, or add documentation (although there's the wiki too). Although be careful, obviously. But almost anything can be backed out from, because of the version control.