diff options
| author | Thomas Waldmann <tw AT waldmann-edv DOT de@localhost> | 2011-07-03 23:42:04 +0200 |
|---|---|---|
| committer | Thomas Waldmann <tw AT waldmann-edv DOT de@localhost> | 2011-07-03 23:42:04 +0200 |
| commit | 7c698b038ed739fe9d932c83b31ab6fc57d02307 (patch) | |
| tree | 8d143447f48c218db43d6c1bc3982c08e9dae232 | |
| parent | e8196bad2f46a2812538ab5e82ee46746305d955 (diff) | |
| download | xstatic-git-7c698b038ed739fe9d932c83b31ab6fc57d02307.tar.gz | |
docs: added some more details/infos
| -rw-r--r-- | docs/source/intro.rst | 2 | ||||
| -rw-r--r-- | docs/source/packaging.rst | 11 |
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/source/intro.rst b/docs/source/intro.rst index e87f2e6..6f04e7b 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -34,6 +34,8 @@ Pros in your main project's setup * you do not need to add 3rd party files to your repository or your distribution archives +* supports development / virtualenv / windows installs (where no other package + management tools are available) * less work for linux distribution package maintainers, you already have split your stuff into separate packages, so they don't need to * outsource some work to other people. there are lots of people needing these diff --git a/docs/source/packaging.rst b/docs/source/packaging.rst index ad37166..d251c6d 100644 --- a/docs/source/packaging.rst +++ b/docs/source/packaging.rst @@ -28,6 +28,8 @@ steps: included in the package created later. * Edit README.txt and replace references to jQuery with FooBar. This file's content will also be shown as long description on PyPi. + Please note that this file is written in reST markup, so that PyPi can + generate your project's page from it. * If you use Mercurial, update .hgignore so it ignores: ^XStatic_FooBar.egg-info/ * Review all the stuff you did, make sure you did not forget anything, make @@ -59,6 +61,9 @@ There are 3 names involved and you should follow these rules: * display_name (metadata): the name as the upstream project itself spells it, e.g. jQuery or FooBar. No spaces. +Note: if you are not packaging original files, but modified files, then you +must use a name that makes this fact obvious. + Version Numbers --------------- As you are just repackaging another project, you should use the upstream @@ -96,4 +101,10 @@ you can give the URLs via the locations metadata. If you do not have a CDN for the files, just use locations = {}. +Licensing +--------- +You should put your XStatic-FooBar package under same license as the upstream +FooBar package. This avoids licensing complications and is also appropriate +because you only added a little metadata anyway. + |