Merge pull request #199 from clinthowarth/master
authorKenneth Reitz <me@kennethreitz.com>
Sun, 23 Sep 2012 10:55:59 +0000 (03:55 -0700)
committerKenneth Reitz <me@kennethreitz.com>
Sun, 23 Sep 2012 10:55:59 +0000 (03:55 -0700)
clean up license overview, add emacs starting points

docs/dev/env.rst
docs/writing/license.rst

index 88dd0d2..7769e4c 100644 (file)
@@ -64,7 +64,7 @@ Python-mode
 ^^^^^^^^^^^
 
 Python-mode_ is complex solution in VIM for work with python code.
-It's have:
+It has:
 
 - Async python code checking (pylint, pyflakes, pep8, mccabe) in any combination;
 - Code refactoring and autocompletion with Rope;
@@ -90,6 +90,21 @@ And more stuff.
 
 .. todo:: add supertab notes
 
+Emacs
+-----
+
+Emacs is a powerful text editor. It's fully programmable (lisp), but
+it can be some work to wire up correctly. A good start if you're
+already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
+
+1. Emacs itself comes with a python mode.
+2. Python ships with an alternate version:
+   `python-mode.el <https://launchpad.net/python-mode>`_
+3. Fabián Ezequiel Gallina's provides nice functionality and
+   behavior out of the box: `python.el <https://github.com/fgallina/python.el>`_
+
+.. _Python Programming in Emacs: http://emacswiki.org/emacs/PythonProgrammingInEmacs
+
 TextMate
 --------
 
@@ -202,7 +217,7 @@ environment, just remove the directory it was installed into. (In this
 case, it would be ``rm -rf venv``).
 
 Other Notes
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 Running ``virtualenv`` with the option ``--no-site-packages`` will not
 include the packages that are installed globally. This can be useful
index 3b4f479..9e759ba 100644 (file)
@@ -1,16 +1,21 @@
 Choosing a License
 ==================
 
-Open source.
+Your source publication *needs* a license. In the US, if no license is
+specified, users have no legal right to download, modify, or
+distribute. Furthermore, people can't contribute to your code unless
+you tell them what rules to play by. It's complicated, so here are
+some pointers:
 
-There are plenty of `open source licenses <http://opensource.org/licenses/alphabetical>`_
-available to choose from.
+Open source. There are plenty of `open source licenses
+<http://opensource.org/licenses/alphabetical>`_ available to choose
+from.
 
 In general, these licenses tend to fall into one of two categories:
 
 1. licenses that focus more on the user's freedom to do with the
    software as they please (these are the more-permissive open
-   source licenses such as the MIT, BSD, & Apache), and
+   source licenses such as the MIT, BSD, & Apache).
 
 2. licenses that focus more on making sure that the code itself —
    including any changes made to it and distributed along with it —
@@ -22,51 +27,26 @@ someone to add code to the software and distribute it without also
 including the source code for their changes.
 
 To help you choose one for your project, there's a `license chooser <http://three.org/openart/license_chooser/>`_,
-use it.
+**use it**.
 
+**More-Permissive**
 
-More-Permissive
-:::::::::::::::
+- PSFL (Python Software Foundation License) -- for contributing to python itself
+- MIT / BSD / ISC
 
-PSFL
-----
+  + MIT (X11)
+  + New BSD
+  + ISC
 
+- Apache
 
-MIT / BSD / ISC
----------------
+**Less-Permissive:**
 
+- LGPL
+- GPL
 
-MIT (X11)
-`````````
+  + GPLv2
+  + GPLv3
 
-New BSD
-```````
-
-ISC
-```
-
-Apache
-------
-
-
-Less-Permissive
-:::::::::::::::
-
-
-LGPL
-----
-
-
-
-GPL
----
-
-
-GPLv2
-`````
-
-
-GPLv3
-`````