Add README files to explain how third-party code is maintained in these
authorTodd Larsen <tlarsen@google.com>
Tue, 16 Sep 2008 16:42:55 +0000
changeset 153 79d52c2d50a2
parent 152 7c1e2cb6dc44
child 154 d2377425d3f2
Add README files to explain how third-party code is maintained in these directories.
app/README
thirdparty/README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/app/README	Tue Sep 16 16:42:55 2008 +0000
@@ -0,0 +1,31 @@
+trunk/app should contain only the files needed for the actual Google App
+Engine application "image".  Support code that is not part of the application
+image belongs elsewhere, such as in trunk/scripts, for example.
+
+= THIRD PARTY CODE =
+
+Third-party code that is *not* part of the application image (the Google App
+Engine SDK in trunk/thirdparty/google_appengine, for example) belongs in
+trunk/thirdparty (see also trunk/thirdparty/README).
+
+Third-party code that is part of the application image is placed in a package
+subdirectory in trunk/app, such as trunk/app/django, for example.
+
+If the third-party package is a single Python source file, place the code in
+trunk/app/<package>/__init__.py, so that it can simply be imported using,
+for example:
+
+import feedparser
+
+(The trunk/app/feedparser package is a good example of this approach.)
+
+== THIRD PARTY LICENSES ==
+
+Third-party code must also include a license text file, named LICENSE or
+COPYING, in the package subdirectory.  If the third-party package subdirectory
+is maintained automatically with a tool such as svn_load_dirs.pl (which
+removes files, such as license text files, that were added later to the
+"target" directory), place the license text file in the trunk/app directory
+and add the package name as a suffix (LICENSE.django is an example of this
+case).
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/thirdparty/README	Tue Sep 16 16:42:55 2008 +0000
@@ -0,0 +1,14 @@
+Third-party code that is *not* part of the application image (the Google App
+Engine SDK in trunk/thirdparty/google_appengine, for example) belongs in
+trunk/thirdparty.  For third-party code that *is* part of the application
+image, see the notes in trunk/app/README.
+
+== THIRD PARTY LICENSES ==
+
+Third-party code must also include a license text file, named LICENSE or
+COPYING, in the package subdirectory.  If the third-party package subdirectory
+is maintained automatically with a tool such as svn_load_dirs.pl (which
+removes files, such as license text files, that were added later to the
+"target" directory), place the license text file in the trunk/app directory
+and add the package name as a suffix.
+