docs: added some more details/infos

This commit is contained in:
Thomas Waldmann
2011-07-03 23:42:04 +02:00
parent 2ef9e4d843
commit 66fed61834
2 changed files with 13 additions and 0 deletions

View File

@@ -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

View File

@@ -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.