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

Github minutia #4

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Github minutia #4

wants to merge 3 commits into from

Conversation

arendsee
Copy link

@arendsee arendsee commented Oct 1, 2016

These are all pretty minor changes.

I added a gitignore file so the temporary files won't clutter the repository, are easily removed, and won't accidentally committed.

I standardized formatting in the README. Replaced carriage returns with newlines and things like that. Also I wrapped all the lines at 80 characters; this has no impact on the compiled HTML, but makes reading easier for people in text editors. I can revert this if you like.

The biggest change is that addition of continuous integration with Travis. Most major repositories on github now use Travis (or a similar service) to tell users whether a given commit/version builds successfully and passes whatever tests the developers subject the code to. If you jump over to my fork, you'll see a little green shield above the README that says "build passing". You can adapt the .travis.yml file to run whatever tests you like.

You will need to update the first line in the README to point to your repository. Just replace the line with this:

[![Build Status](https://travis-ci.org/bioinfologics/satsuma2.svg?branch=master)](https://travis-ci.org/bioinfologics/satsuma2)

The Travis build uses gcc-v5 and cmake v3.2.

The build succeeds if test_SatsumaSynteny2 exits successfully. The
output redirected to /dev/null; this is required since Travis does not
like long messages (failing the build if log is greater than 4MB).

NOTE: I had to decrement the required cmake version from 3.3 to 3.2 in
order to be compatible with Travis.
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

Successfully merging this pull request may close these issues.

1 participant