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

better document the supported SCMs #142

Closed
cdeil opened this issue Jan 7, 2017 · 1 comment
Closed

better document the supported SCMs #142

cdeil opened this issue Jan 7, 2017 · 1 comment

Comments

@cdeil
Copy link

cdeil commented Jan 7, 2017

Currently the short description of this package at https://github.com/pypa/setuptools_scm#setuptools_scm reads like this:

setuptools_scm handles managing your python package versions in scm metadata instead of declaring them as the version argument or in a scm managed file.
It also handles file finders for the supported scm's.

What are the currently supported SCMs?
I think it's hg and git from looking at the code.
Maybe mention this in the README?

If you confirm that it's git and hg, I could add that info to the README? How about right after that sentence talking about supported SCMs?

@RonnyPfannschmidt
Copy link
Contributor

currently its only git and hg

there should probably also be a section on making plugins for others scm's via plugins/entry-points/custom functions, unfortunately my time is currently rather limited

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