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

Usage information should be in scripts/README.md #1

Open
rufuspollock opened this issue Mar 11, 2016 · 4 comments
Open

Usage information should be in scripts/README.md #1

rufuspollock opened this issue Mar 11, 2016 · 4 comments
Assignees

Comments

@rufuspollock
Copy link
Member

Can we move this info to scripts/README.md https://github.com/datasets/inflation#usage-of-inflation2datapackagepy

@zelima
Copy link
Member

zelima commented Mar 11, 2016

@rgrp I moved usage information in to new README.md in scripts folder.
The README.md in inflation folder is left, but without usage information?
Correct, or i should move entire README.md into scripts folder?

@rufuspollock
Copy link
Member Author

@zelima yes that's right. Sometimes if you want you can leave a heading called "Preparation" and say under it something like:

"See scripts/README.md"

BTW I assume you have read through http://data.okfn.org/doc/publish-faq#readme

@zelima
Copy link
Member

zelima commented Mar 13, 2016

I'll read this more carefully now.
Will modify READMY.md after we deal with script problem.

@zelima
Copy link
Member

zelima commented Mar 15, 2016

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