Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Communicate "dev" requirements #27

Open
seanenck opened this issue Mar 7, 2017 · 7 comments
Open

Communicate "dev" requirements #27

seanenck opened this issue Mar 7, 2017 · 7 comments

Comments

@seanenck
Copy link

seanenck commented Mar 7, 2017

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?

@ckaran
Copy link
Collaborator

ckaran commented Mar 7, 2017

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.

@seanenck
Copy link
Author

seanenck commented Mar 9, 2017

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

@ckaran
Copy link
Collaborator

ckaran commented Mar 13, 2017

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.

@seanenck
Copy link
Author

travis will fail the build if something like the make (or other) returns non-zero so assuming pdflatex/pandoc/etc. do that - yes.

@ckaran
Copy link
Collaborator

ckaran commented Mar 13, 2017

Are you willing to test that on your fork?

@seanenck
Copy link
Author

already did that in my travisci branch

@ckaran
Copy link
Collaborator

ckaran commented Mar 13, 2017

Nice! I'd definitely like to set up something like that in this repo! 👍

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

No branches or pull requests

2 participants