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 could use an example of how to install and run this tool #1

Closed
yurishkuro opened this issue Nov 8, 2016 · 4 comments
Closed
Assignees

Comments

@yurishkuro
Copy link
Collaborator

Also, I wonder if it's possible to put it as go:generate directive in the doc.go files themselves so that it's easy to regenerate across the repo when README files change.

@yurishkuro
Copy link
Collaborator Author

@sectioneight meanwhile, I gave it a try: https://github.com/uber/jaeger/pull/3

@ascandella ascandella self-assigned this Nov 8, 2016
@ascandella
Copy link
Owner

ascandella commented Nov 8, 2016

Yea, we have some make rules in UberFx -- go generate is an interesting idea

@yurishkuro
Copy link
Collaborator Author

I used go:generate, followed by updateLiceses, but had to put the directives into another file md2doc.go

ascandella added a commit that referenced this issue Nov 10, 2016
ascandella pushed a commit that referenced this issue Nov 10, 2016
@ascandella
Copy link
Owner

Cool. FYI the latest version uses // comments to be a bit more idiomatic.
On Fri, Nov 11, 2016 at 1:24 PM Yuri Shkuro notifications@github.com
wrote:

@sectioneight https://github.com/sectioneight meanwhile, I gave it a
try: uber/jaeger#3 https://github.com/uber/jaeger/pull/3


You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub
#1 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAF7PyGeqyPaOpw18T0K-p4oaFwOTm5Rks5q8MD1gaJpZM4KsuYp
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants