Clean-up README/CONTRIBUTING

vmuriart · vmuriart · commit d17268e6f3b5 · 2017-01-14T15:44:34.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,36 +8,36 @@ contribution under the MIT license to this project.
 
 ## Getting Started
 
-* Make sure you have a [GitHub account](https://github.com/signup/free)
-* Submit a ticket for your issue, assuming one does not already exist.
-  * Clearly describe the issue including steps to reproduce when it is a bug.
-  * Make sure you include what Python version and operating system you are using.
-* Fork the repository on GitHub
+-   Make sure you have a [GitHub account](https://github.com/signup/free)
+-   Submit a ticket for your issue, assuming one does not already exist.
+    -   Clearly describe the issue including steps to reproduce the bug.
+    -   Include what Python version and operating system you are using.
+-   Fork the repository on GitHub
 
 ## Making Changes
 
-* Create a topic branch from where you want to base your work.
-  * This is usually the master branch.
-  * Only target release branches if you are certain your fix must be on that
-    branch.
-  * To quickly create a topic branch based on master; `git checkout -b
-    fix/develop/my_contribution master`. Please avoid working directly on the
-    `master` branch for anything other than trivial changes.
-* Make commits of logical units.
-* Check for unnecessary whitespace with `git diff --check` before committing.
-* Make sure your commit messages are in the proper format.
-* Make sure you have added the necessary tests for your changes.
-* Run _all_ the tests to assure nothing else was accidentally broken.
-
+-   Create a topic branch from where you want to base your work.
+    -   This is usually the master branch.
+    -   Only target release branches if you are certain your fix must be on
+        that branch.
+    -   To quickly create a topic branch based on master;
+        `git checkout -b fix/develop/my_contribution master`.
+        Please avoid working directly on the `master` branch for anything
+        other than trivial changes.
+-   Make commits of logical units.
+-   Check for unnecessary whitespace with `git diff --check` before committing.
+-   Make sure your commit messages are in the proper format.
+-   Make sure you have added the necessary tests for your changes.
+-   Run _all_ the tests to assure nothing else was accidentally broken.
 
 ## Submitting Changes
 
-* Merge your topic branch into master and push to your fork of the repository.
-* Submit a pull request to the repository in the pythonnet organization.
-* After feedback has been given we expect responses within two weeks. After two
-  weeks we may close the pull request if it isn't showing any activity.
+-   Merge the topic branch into master and push to your fork of the repository.
+-   Submit a pull request to the repository in the pythonnet organization.
+-   After feedback has been given we expect responses within two weeks. After
+    two weeks we may close the pull request if it isn't showing any activity.
 
 # Additional Resources
 
-* [General GitHub documentation](https://help.github.com/)
-* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
+-   [General GitHub documentation](https://help.github.com/)
+-   [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
diff --git a/README.md b/README.md
@@ -1,65 +1,83 @@
-pythonnet
-=========
+# pythonnet - Python for .NET
 
-Python for .NET is a package that gives Python programmers nearly seamless integration with the .NET Common Language Runtime (CLR) and provides a powerful application scripting tool for .NET developers. It allows Python code to interact with the CLR, and may also be used to embed Python into a .NET application.
+Python for .NET is a package that gives Python programmers nearly
+seamless integration with the .NET Common Language Runtime (CLR) and
+provides a powerful application scripting tool for .NET developers.
+It allows Python code to interact with the CLR, and may also be used to
+embed Python into a .NET application.
 
-[![Build Status](https://travis-ci.org/pythonnet/pythonnet.png?branch=master)](https://travis-ci.org/pythonnet/pythonnet)
+[![travis shield][]](https://travis-ci.org/pythonnet/pythonnet)
+[![appveyor shield][]](https://ci.appveyor.com/project/pythonnet/pythonnet-0kq5d/branch/master)
+[![license shield][]](./LICENSE)
 
-[![Build status](https://ci.appveyor.com/api/projects/status/g4flfwq46g2adv6a/branch/master?svg=true)](https://ci.appveyor.com/project/pythonnet/pythonnet-0kq5d/branch/master)
+## Calling .NET code from Python
 
-**Calling .NET code from Python**
-
-Python for .NET allows CLR namespaces to be treated essentially as Python packages.
+Python for .NET allows CLR namespaces to be treated essentially
+as Python packages.
 
 ```python
-    import clr
-    from System import String
-    from System.Collections import *
+import clr
+from System import String
+from System.Collections import *
 ```
-To load an assembly, use the "AddReference" function in the "clr" module:
+
+To load an assembly, use the `AddReference` function in the `clr` module:
 
 ```python
-    import clr
-    clr.AddReference("System.Windows.Forms")
-    from System.Windows.Forms import Form
+import clr
+clr.AddReference("System.Windows.Forms")
+from System.Windows.Forms import Form
 ```
 
-**Embedding Python in .NET**
+## Embedding Python in .NET
+
+-   All calls to python should be inside
+    a `using (Py.GIL()) {/_ Your code here _/}` block.
+-   Import python modules using `dynamic mod = Py.Import("mod")`,
+    then you can call functions as normal, eg `mod.func(args)`.
+-   Use `mod.func(args, Py.kw("keywordargname", keywordargvalue))`
+    to apply keyword arguments.
+-   All python objects should be declared as `dynamic` type.
+-   Mathematical operations involving python and literal/managed types must
+    have the python object first, eg `np.pi_2` works, `2_np.pi` doesn't.
 
-+ All calls to python should be inside a "using (Py.GIL()) {/* Your code here */}" block.
-+ Import python modules using dynamic mod = Py.Import("mod"), then you can call functions as normal, eg mod.func(args).
-+ Use mod.func(args, Py.kw("keywordargname", keywordargvalue)) to apply keyword arguments.
-+ All python objects should be declared as 'dynamic' type.
-+ Mathematical operations involving python and literal/managed types must have the python object first, eg np.pi*2 works, 2*np.pi doesn't
+### Example
 
-EG:
 ```csharp
 static void Main(string[] args)
 {
-  using (Py.GIL()) {
-    dynamic np = Py.Import("numpy");
-    dynamic sin = np.sin;
-    Console.WriteLine(np.cos(np.pi*2));
-    Console.WriteLine(sin(5));
-    double c = np.cos(5) + sin(5);
-    Console.WriteLine(c);
-    /* this block is temporarily disabled due to regression
-    dynamic a = np.array(new List<float> { 1, 2, 3 });
-    dynamic b = np.array(new List<float> { 6, 5, 4 }, Py.kw("dtype", np.int32));
-    Console.WriteLine(a.dtype);
-    Console.WriteLine(b.dtype);
-    Console.WriteLine(a * b);
-    */
-    Console.ReadKey();
-  }
+    using (Py.GIL())
+    {
+        dynamic np = Py.Import("numpy");
+        dynamic sin = np.sin;
+        Console.WriteLine(np.cos(np.pi*2));
+        Console.WriteLine(sin(5));
+        double c = np.cos(5) + sin(5);
+        Console.WriteLine(c);
+        /* this block is temporarily disabled due to regression
+        dynamic a = np.array(new List<float> { 1, 2, 3 });
+        dynamic b = np.array(new List<float> { 6, 5, 4 }, Py.kw("dtype", np.int32));
+        Console.WriteLine(a.dtype);
+        Console.WriteLine(b.dtype);
+        Console.WriteLine(a * b); */
+        Console.ReadKey();
+    }
 }
 ```
-outputs:
-```
-1.0
--0.958924274663
--0.6752620892
-float64
-int32
-[  6.  10.  12.]
+
+Output:
+
+```c
+    1.0
+    -0.958924274663
+    -0.6752620892
+    float64
+    int32
+    [6.  10.  12.]
 ```
+
+[travis shield]: https://travis-ci.org/pythonnet/pythonnet.png?branch=master
+
+[appveyor shield]: https://ci.appveyor.com/api/projects/status/g4flfwq46g2adv6a/branch/master?svg=true
+
+[license shield]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
