Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

README editing. #26

Merged
merged 1 commit into from Apr 14, 2012

Conversation

Projects
None yet
2 participants
Contributor

theory commented Nov 27, 2011

In response to your request for a proof.

One comment: In most of the example commands, you include the name of the extension. Is it not the case that if you run the tasks in the extension root directory, you don't have to do that? That is, it assumes the current directory? If so, I think that should be spelled-out, as well.

Also, I've noticed that when I do that, pgxn-utils bundle puts the zip file in the parent directory. Took me a few minutes to find it. I think it should just be created in the current directory, or else there should be a message saying where to find it. Furthermore, I think that pgxn release should know where to find it, too (which, if it was in the current directory, would be simple).

And finally, I suggest you move this file into docs/pgxn-utils.md or similar, add a docfile key to provides:pgxn_utils that points at it, and then make the README.md more generic. I'm thinking like semver, where the README has installation and license information, and the doc/semver.mmd file is the usage documentation. Thoughts?

Thanks agin for this, looks great!

Oh, one more thing: How about mentioning the integration with the pgxn command-line client?

@guedes guedes added a commit that referenced this pull request Apr 14, 2012

@guedes guedes Merge pull request #26 from pgxn/readme-tweaks
README editing.
283397b

@guedes guedes merged commit 283397b into guedes:master Apr 14, 2012

Owner

guedes commented Apr 14, 2012

Thank you @theory ! I'll improve the docs as you suggested.

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