markormesher
Markdown
It would be cool if these notes go on to be used by other students in the future. It would be even cooler if those students could add to them and fix the odd typo. Is it worth converting these notes to Markdown so others can easily make suggestions?
The good news is that these notes will definitely remain available to help other students in the future 😄 I've just finished my fourth year, but I know some students three years below me who were using these recently. I'll be leaving them online indefinitely, so they should be helpful until they become too old and out of date.
Converting them to a text-based format would be great, but unfortunately there is far too much complex formatting for Markdown to be suitable (formulae, for example, do not convert nicely to MD).
The PDFs are created from LaTeX; if I published them it would allow people to submit corrections, and I may make those originals available some day. My only hesitation is this: I published LaTeX originals in the past, and within 48 hours someone had replaced my name with theirs, removed my copyright notice, and attempted to sell copies. If I can find a way to publish them without increasing the risk that nefarious individuals will use these notes to rip off others, I will definitely give it consideration. If you have any ideas, I'd love to hear them!
I saw your fork with the code examples, by the way - thanks for the contribution! I do feel like they might be better placed in a separate repo though, as this one is more for written notes, but I'd be happy to link to them from the readme (and/or put a link in the respective module folders).
I'm not surprised they are getting used - they're awesome!
wrt markdown, I did think that might be an issue but I wasn't sure if you were using LaTex or just raw images. It would be great if 'not-arses' could access the originals and add to your work over time. Maybe you could put the originals on a private repo and invite people who want to suggest edits.
I was going to put in a PR once I had a few more examples and tidied up the ones that are there but a separate repo would make sense too. I'll raise another issue once once I've put something together.
A private repo for the notes with a few people added as contributors is not a bad idea actually, thanks! I'm travelling for work at the moment so I don't have access to the LaTeX originals, but I will take a look at this when I'm back in the UK. Wouldn't be too hard to set something up on my end to recompile and upload the notes when PRs get merged.
Let me know if/when you set up a repo for examples and I can put a link in the respective READMEs