Now that we’ve moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation (and maybe also changelog?).

CommentFileSizeAuthor
#6 3082868-6--readme_md.patch13.22 KBdrunken monkey
#6 3082868-6--readme_md--interdiff.txt12.23 KBdrunken monkey
#5 3082868-5.patch6.83 KBraunak.singh
#2 3082868-2.patch101 bytesrokzabukovec

Comments

drunken monkey created an issue. See original summary.

rokzabukovec’s picture

rokzabukovec commented
Status: Active » Needs review
StatusFileSize
new 3082868-2.patch101 bytes

I renamed the file.
Best regards.

drunken monkey’s picture

drunken monkey
he/him
Primary language German
Location Vienna, Austria
commented
Status: Needs review » Active

I didn’t mean just changing the filename, but also re-formatting it as Markdown.

raunak.singh’s picture

raunak.singh commented
Assigned: Unassigned » raunak.singh

I will create a patch with re-formatting readme file as per #3

raunak.singh’s picture

raunak.singh commented
Assigned: raunak.singh » Unassigned
Status: Active » Needs review
StatusFileSize
new 3082868-5.patch6.83 KB

Hi @drunken monkey,
Please review this patch and let me know if there is an issue.

drunken monkey’s picture

drunken monkey
he/him
Primary language German
Location Vienna, Austria
commented
StatusFileSize
new 3082868-6--readme_md--interdiff.txt12.23 KB
new 3082868-6--readme_md.patch13.22 KB

Thanks a lot, great job!

However, we can definitely also improve the links, some of the inline code and also make the headings normal-case when they are clearly marked as headings already anyways.
Please see the attached patch revision and tell me what you think!

drunken monkey’s picture

drunken monkey
he/him
Primary language German
Location Vienna, Austria
commented
Status: Needs review » Fixed

Committed.
Thanks again!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.