Skip to content

Improve the README file#55

Open
throwaway1037 wants to merge 1 commit intowjaguar:masterfrom
throwaway1037:patch-1
Open

Improve the README file#55
throwaway1037 wants to merge 1 commit intowjaguar:masterfrom
throwaway1037:patch-1

Conversation

@throwaway1037
Copy link

  • Rename README to README.md
  • Reformat as markdown (GFM) document
  • Update GTK+1, GTK+2 and GTK+3 to GTK 1, GTK 2, and GTK 3, respectively
  • Reword some sections to improve grammar
  • Break sentences into individual lines to improve diffs
  • Remove double spaces after end of sentences
  • Remove empty lines at EOF
  • Upgrade http links to https
  • Change instances of the word "create" to less ambiguous words - https://gnu.org/philosophy/words-to-avoid.html
  • Other formatting alterations to improve the readability of the file

- Rename `README` to `README.md`
- Reformat as markdown (GFM) document
- Update GTK+1, GTK+2 and GTK+3 to GTK 1, GTK 2, and GTK 3, respectively
- Reword some sections to improve grammar
- Break sentences into individual lines to improve diffs
- Remove double spaces after end of sentences
- Remove empty lines at EOF
- Upgrade http links to https
- Change instances of the word "create" to less ambiguous words - https://gnu.org/philosophy/words-to-avoid.html
- Other formatting alterations to improve the readability of the file
@throwaway1037 throwaway1037 marked this pull request as ready for review March 11, 2021 05:54
@wjaguar
Copy link
Owner

wjaguar commented Mar 11, 2021

In reality it is not that simple, because README serves as source for several scripts.
Also GTK+4 won't be worth mentioning around sane folk for another 2 years at the least, based on timeline of GTK+3 and GTK+2 before that.

Nevertheless, thank you for your work; this will be helpful when/if I do switch the file to Markdown from plain ASCII.

@throwaway1037
Copy link
Author

You're welcome.

@basxto
Copy link

basxto commented Feb 8, 2022

Oh, I overlooked that this is also a markdown PR. https doesn’t work for sourceforge pages.

What does read the README file? doc/makehelp.pl gtk/winbuild64.sh gtk/winbuild.sh?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants