symlink divisi2 in here, update developer docs some more

commonsense · May 7, 2010 · 3bbe12c · 3bbe12c
1 parent 0cd07f4
commit 3bbe12c
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 203 deletions.
diff --git a/conceptnet b/conceptnet
diff --git a/divisi2 b/divisi2
diff --git a/docs/developers/bzr-howto.rst b/docs/developers/bzr-howto.rst
diff --git a/docs/developers/contributions.rst b/docs/developers/contributions.rst
@@ -5,16 +5,23 @@ Open Mind is an open source project. If you see something you can improve in
 the code, we encourage you to share your improvement with us so we can include
 it in future versions.
 
-Pushing code to Launchpad
+GitHub branches and forks
 -------------------------
 
-As a developer, you have presumably checked out our code from Launchpad. The
-first step in sharing your improvements is to push your branch back to
-Launchpad, under your own name. So for example, if your Launchpad username is
-jbloggs, and you have an improvement to Divisi that makes SVDs faster, you
-could push it to Launchpad with::
-  
-   bzr push lp:~jbloggs/divisi/make-svds-faster
+As a developer, you have presumably checked out our code from GitHub. GitHub
+makes it very easy to "fork" a project -- that's not as disruptive as it
+sounds, it's just hosting a copy of the project under your own GitHub account.
+In the fork, you can make whatever changes you want, you can pull our later
+updates, and we can pull your updates when we want to include them in the main
+repository.
+
+Instructions on forking are at: http://help.github.com/forking/
+
+
+If you work closely with us, you may have access to the main repositories under
+"commonsense/". In that case, you don't have to make a complete fork; you can
+just make a new branch where you make your changes.
+http://progit.org/book/ch3-0.html is a very helpful guide to branching.
 
 Letting Commonsense Computing redistribute your code
 ----------------------------------------------------
@@ -42,7 +49,7 @@ just get to redistribute your code. You will be credited for your contributions
 in the source code. 
 
 How does this compare to other open source projects?
-----------------------------------------------------
+....................................................
 Our terms for contributors are most similar to the Qt_ project. Their
 contributors have to sign a `contribution agreement`_ very similar to this one.
 

diff --git a/docs/developers/index.rst b/docs/developers/index.rst
@@ -9,7 +9,6 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   bzr-howto
    setup
    karma
    contributions

diff --git a/docs/developers/karma.rst b/docs/developers/karma.rst
@@ -26,15 +26,13 @@ package. Writing docstrings for functions you use, or for new functions you
 have written, is an easy form of coding karma. These docstrings can easily be
 included in more complete documentation later.
 
-The documentation repository
-----------------------------
-
-We have a documentation repository. In fact, you're *reading* the output of the
-documentation repository right now.
+The documentation directory
+---------------------------
 
-You can check it out with `bzr checkout lp:~commonsense/cscweb/documentation`.
-A plain checkout is probably fine -- there shouldn't be any reason to have
-different branches of documentation.
+What you're reading right now comes from a directory called "docs" under the
+"omcs" Git repository. You can edit it in its checked-out version, or you can
+make changes through the Web at
+http://github.com/commonsense/omcs/tree/master/docs/.
 
 The documentation repository contains a couple of things:
 
@@ -49,12 +47,9 @@ Writing "recipes"
 If you have an example of accomplishing something useful with our tools, show
 it to other people! 
 
-The `recipes/` directory of the documentation repository is the place to put
+The `recipes/` directory of the documentation is the place to put
 these. They can even be included as pages of the Sphinx documentation later.
 
-Rob's getting this started by including `health_blend.py` in the recipes
-directory.
-
 Writing tests
 -------------
 We use `nose` for testing. You can get this program with::
@@ -142,11 +137,11 @@ of the docstrings.
 
 If you have access to the docs server, and you have Fabric installed
 (``easy_install fabric``), you can update the
-documentation on the Web site (http://csc.media.mit.edu/doc/) by running::
+documentation on the Web site (http://csc.media.mit.edu/docs/) by running::
 
-  bzr commit
+  git commit -a
   fab test
-  fab update # if the test works
+  fab update    # if the test works
 
 "fab update" might crash with an error about setting attributes on files, but
 if it does, it already got far enough.
+1 −2		.gitignore
+10 −0		README.rst
+19 −8		csc/conceptnet/models.py
+35 −0		csc/conceptnet/network.py
+ −		csc/nl/mblem/en.mblem.pickle
+ −		csc/nl/mblem/en.unlem.pickle
+95 −14		csc/webapi/handlers.py
+8 −0		csc/webapi/urls.py
+35 −16		maint/fix_raw_duplicates.py
+4 −3		maint/import_conceptnet_zh.py
+0 −0		temp.txt
+1 −0		.gitignore
+4 −0		MANIFEST.in
+1 −0		TODO.txt
+5 −2		csc/divisi2/__init__.py
+0 −0		csc/divisi2/blending.py
+ −		csc/divisi2/data/matrices/conceptnet_en
+56 −6		csc/divisi2/dense.py
+4 −3		csc/divisi2/network.py
+54 −0		csc/divisi2/operators.py
+107 −3		csc/divisi2/ordered_set.py
+0 −107		csc/divisi2/recycling_set.py
+2 −0		csc/divisi2/sparse.py
+1 −3		csc/divisi2/test/eval/test_predictions.py
+5 −0		csc/divisi2/test/test_dense.py
+1 −1		doc/conf.py
+0 −0		doc/index.rst
+3 −3		fabfile.py
+3 −0		requirements-dev.txt
+2 −1		requirements.txt
+17 −16		setup.py