flyswot icon indicating copy to clipboard operation
flyswot copied to clipboard
verified publisher icon davanstrien

Adding contextual information about the whole project

Open andrewlongworth opened this issue 4 years ago • 1 comments

Where/how's the best place to add some text about why we're doing this, from an HMD perspective?

New document / edit the README file?

I've started drafting some general background text in a Word doc, should I just upload that?

andrewlongworth avatar May 12 '21 09:05 andrewlongworth

I think for now it could go in the README and we might want to move things into separate pages if the docs get a bit longer.

If you could make a pull request to add that to the README that would be great. Let me know if you need any help doing that. Probably the easiest way to do that is to edit the README on GitHub by clicking on the pencil in the top right:

Screenshot 2021-05-12 at 13 11 49

Once you've made the changes you should have an option at the bottom to 'Create new branch and make pull request'

Screenshot 2021-05-12 at 13 12 25

The readme is formatted in restructuredtext which is similar to Markdown. If the formatting doesn't make sense feel free to just add the text somewhere and I can check the formatting before merging the pull request.

davanstrien avatar May 12 '21 12:05 davanstrien