search

loopspace / braids

TikZ package for drawing braids
6 stars 1 forks source link

a readme file for the git repo #4

Closed nilesjohnson closed 12 months ago

nilesjohnson commented 12 months ago

with explanations about how to generate the files and run tests

It took me a while to figure this out, and I figured that other people might appreciate it. There are a few things that you might want to modify:

  1. If you have a better way to explain how to actually use the generated files here, instead of the system defaults, you could add it. I just don't know.
  2. I use the one-sentence-per-line convention, but it looks like maybe you use a different line wrapping. If that's something you have a strong preference about, I'm happy to switch.
  3. I just sort of copied the intro from various parts of your documentation, based on the readme file you have for tikzmark. If you want to improve it somehow, please do!

If you want, you could just tell me here and I'll make any changes you like. Or, you can just make them yourself :)

loopspace commented 12 months ago

I'm happy to merge this in and then work with it from there. I'll think about your points 1&3 to see whether there's anything I'd say differently. As for line-wrapping, I'm very definitely in the one-sentence-per-line camp - https://loopspace.mathforge.org/HowDidIDoThat/TeX/VCS/#section.3 -, but something my text editor had other ideas and I think that with readmes then there were times that I gave up fighting it!