]> sipb.mit.edu Git - snippets/.git/commitdiff
Move Django docs up a level, to ease subtree merging
authorAlex Dehnert <adehnert@mit.edu>
Sat, 30 Nov 2013 06:36:07 +0000 (01:36 -0500)
committerAlex Dehnert <adehnert@mit.edu>
Sat, 30 Nov 2013 06:36:07 +0000 (01:36 -0500)
django/COPYING [moved from django/mit/COPYING with 100% similarity]
django/README [new file with mode: 0644]
django/mit/README [deleted file]

similarity index 100%
rename from django/mit/COPYING
rename to django/COPYING
diff --git a/django/README b/django/README
new file mode 100644 (file)
index 0000000..5975e8d
--- /dev/null
@@ -0,0 +1,18 @@
+/mit/__init__.py contains some useful functionality for Django applications
+running at MIT, particularly on the scripts.mit.edu platform
+- zephyr(msg, clas, instance, rcpt) sends a zephyr (by shelling out to zwrite).
+  This may be useful for debugging or logging
+- ScriptsRemoteUserMiddleware and ScriptsRemoteUserBackend work together to
+  auto-create users from certificates on scripts.mit.edu-hosted sites. Account
+  details are automatically retrieved from LDAP.
+- scripts_login is a view that tries to log users into a site using certs.
+To use them, you'll probably want to symlink or copy the "mit" directory into
+your project, add it to your apps list, and modify your middlewares and auth
+backend appropriately. Do *not* link this (the "django" directory) into your
+app; it's reasonably likely to break your "import django.foo" statements.
+This code is descended from work on Remit (https://remit.scripts.mit.edu/trac/)
+and the ASA DB (https://asa.scripts.mit.edu/trac/); current and past bugs are
+likely to be filed there.
diff --git a/django/mit/README b/django/mit/README
deleted file mode 100644 (file)
index 8271dac..0000000
+++ /dev/null
@@ -1,17 +0,0 @@
-__init__.py contains some useful functionality for Django applications running
-at MIT, particularly on the scripts.mit.edu platform
-* zephyr(msg, clas, instance, rcpt) sends a zephyr (by shelling out to zwrite).
-  This may be useful for debugging or logging
-* ScriptsRemoteUserMiddleware and ScriptsRemoteUserBackend work together to
-  auto-create users from certificates on scripts.mit.edu-hosted sites. Account
-  details are automatically retrieved from LDAP.
-* scripts_login is a view that tries to log users into a site using certs.
-To use them, you'll probably want to symlink or copy this directory ("mit")
-into your project, add it to your apps list, and modify your middlewares and
-auth backend appropriately. Do *not* link the django directory into your app;
-it's reasonably likely to break your "import django.foo" statements.
-This code is descended from work on Remit (https://remit.scripts.mit.edu/trac/)
-and the ASA DB (https://asa.scripts.mit.edu/trac/); current and past bugs are
-likely to be filed there.