Communicate "dev" requirements
seanenck opened this issue · 7 comments
The README.md here is special because it means something different than a normal repo. We probably want some form of indicator for dev, for example to build the pdf/md from the input tex you have to have the forms package installed (along with texlive-*) in Arch (I don't know what dev systems everyone is using).
I'm happy to write setup instructions from an empty Arch install to being able to produce the outputs but not sure if we have a preferred place for that?
How about creating a file named HOW_TO_BUILD? Not quite ideal, but it should work.
You're right though that this turning into a complete project which others can fork and use, so it may be time to start really considering how to create a full build system, along with instructions for it.
I have a travisci branch in my fork that actually does the build for us via travis-ci. I'm not going to create a pull for it but it is an option
Is travis able to detect when a LaTeX build goes bad? I think that having travis integration is going to be a good idea in the future. The only tricky part is making sure that we have tests for each of the major platforms, so that forking is easier for others.
travis will fail the build if something like the make (or other) returns non-zero so assuming pdflatex/pandoc/etc. do that - yes.
Are you willing to test that on your fork?
Nice! I'd definitely like to set up something like that in this repo! 👍