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

Readme: add installation instructions and examples #117

Merged
merged 2 commits into from
Jan 19, 2019

Conversation

oliver-sanders
Copy link
Member

Should suffice for now.

@oliver-sanders oliver-sanders added this to the next-release milestone Jan 18, 2019
@oliver-sanders oliver-sanders self-assigned this Jan 18, 2019
@matthewrmshin
Copy link
Member

(After this we'll need to do a happy new change + an update to CHANGES.md.)

@oliver-sanders
Copy link
Member Author

I've got pytest to run on all .md files so that the python examples in the README.md file get tested. Easy enough.

There are, however, some console examples which will go untested. As this is a problem we have elsewhere in Rose & Cylc I though it might be worth a look-in now that we are using an extendible testing framework.

So ... https://github.com/oliver-sanders/pytest_shelltest

@matthewrmshin
Copy link
Member

Is this sufficient to close #47?

@kinow
Copy link
Member

kinow commented Jan 19, 2019

@kinow
Copy link
Member

kinow commented Jan 19, 2019

Is this sufficient to close #47?

+1 from me. We can close that one now and add more to the documentation based on user/dev feedback later IMO

@kinow kinow merged commit 2484131 into metomi:master Jan 19, 2019
@oliver-sanders oliver-sanders deleted the readme branch January 23, 2019 09:34
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.

3 participants