-
Notifications
You must be signed in to change notification settings - Fork 31
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
Documentation on usage? #5
Comments
There is an example of usage in this project's appveyor.yml file. I will make sure to update this project with other usage examples as well. Thanks. |
Sweet! Got something working, however I'm not sure how well it is going to work on Mono/Ubuntu (Travis CI) - not your fault, OpenCover seems to have issues over there. |
The readme should point to some example. It's really unclear how to get started. Partly also due to the lack of information on https://coveralls.io/ they basically just point to your nuget repo. So the idea is to:
or how far off am I? Also, how to best deal with security tokens now that coverall.net advices not to add the token to the .yml file? |
Appveyor has a tool for putting an enctypted token in the yaml file. You On Sunday, February 8, 2015, Kasper B. Graversen notifications@github.com
Rob http://devlicio.us/blogs/rob_reynolds |
Yeah I found it after much searching https://ci.appveyor.com/tools/encrypt do you want a pullrequest with an updated README.MD detailing how to get started? |
I definitely won't say no to help offered. I'm open to any and all contributions via pull requests if they help advance the tool and/or its usage. |
Here's how I implemented it in Chocolatey using UppercuT:
|
@ferventcoder how do you like my latest changes to the readme.md ? |
Ship it. 👍 |
What do you mean @ferventcoder ? it has already been merged. Do you mean close this issue? |
Sorry. It's a saying meant to mean good to go. |
Thoughts on placing the Getting Started in wiki instead of README.md? I understand the benefit of it being right on the front page, but we're making assumptions about build environments as well as enforcing a specific project layout via the instructions used. I'd rather see a few Getting Started options, especially a quick, local build and run option that doesn't require a CI service. And I would personally prefer the quick start/local option to the Appveyor option as the default in README.md. I figured I would ask instead of dictate as you both seem to be using this a lot more than I am at the moment. Although hopefully I'll be a little more active in the coming weeks. |
Wiki works for me. :) On Monday, February 16, 2015, Jason Deering notifications@github.com
Rob http://devlicio.us/blogs/rob_reynolds |
Fine with me too. As long as the readme points to the wiki:) How do you version the wiki? Wondered myself about documentation. My stateprinter project uses a doc folder instead and has the readme point into the doc folder. This project and mine are for programmers so I'm not sure you will see more edits on the wiki. |
I've started wiki pages for documentation of usage. If anyone wants to help contribute, let me know and I'll add the relevant permissions. |
So what I gather from code-cracker issue is that I need to do something similar to this - https://github.com/code-cracker/code-cracker/blob/master/build.targets.ps1#L195-L198
It would be really nice to see some documentation here though.
The text was updated successfully, but these errors were encountered: