Explorar o código

Create CONTRIBUTING.md

Ben Firshman %!s(int64=11) %!d(string=hai) anos
pai
achega
3a48172332
Modificáronse 2 ficheiros con 30 adicións e 26 borrados
  1. 30 0
      CONTRIBUTING.md
  2. 0 26
      README.md

+ 30 - 0
CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to Fig
+
+If you're looking contribute to [Fig](http://orchardup.github.io/fig/)
+but you're new to the project or maybe even to Python, here are the steps
+that should get you started.
+
+1. Fork [https://github.com/orchardup/fig](https://github.com/orchardup/fig) to your username. kvz in this example.
+1. Clone your forked repository locally `git clone [email protected]:kvz/fig.git`.
+1. Enter the local directory `cd fig`.
+1. Set up a development environment `python setup.py develop`. That will install the dependencies and set up a symlink from your `fig` executable to the checkout of the repo. So from any of your fig projects, `fig` now refers to your development project. Time to start hacking : )
+1. Works for you? Run the test suite via `./scripts/test` to verify it won't break other usecases.
+1. All good? Commit and push to GitHub, and submit a pull request.
+
+## Running the test suite
+
+    $ script/test
+
+## Building binaries
+
+Linux:
+
+    $ script/build-linux
+
+OS X:
+
+    $ script/build-osx
+
+Note that this only works on Mountain Lion, not Mavericks, due to a [bug in PyInstaller](http://www.pyinstaller.org/ticket/807).
+
+

+ 0 - 26
README.md

@@ -47,29 +47,3 @@ Installation and documentation
 ------------------------------
 
 Full documentation is available on [Fig's website](http://orchardup.github.io/fig/).
-
-Running the test suite
-----------------------
-
-    $ script/test
-
-Building OS X binaries
----------------------
-
-    $ script/build-osx
-
-Note that this only works on Mountain Lion, not Mavericks, due to a [bug in PyInstaller](http://www.pyinstaller.org/ticket/807).
-
-Contributing to Fig
--------------------
-
-If you're looking contribute to [Fig](http://orchardup.github.io/fig/)
-but you're new to the project or maybe even to Python, here are the steps
-that should get you started.
-
-1. Fork [https://github.com/orchardup/fig](https://github.com/orchardup/fig) to your username. kvz in this example.
-1. Clone your forked repository locally `git clone [email protected]:kvz/fig.git`.
-1. Enter the local directory `cd fig`.
-1. Set up a development environment `python setup.py develop`. That will install the dependencies and set up a symlink from your `fig` executable to the checkout of the repo. So from any of your fig projects, `fig` now refers to your development project. Time to start hacking : )
-1. Works for you? Run the test suite via `./scripts/test` to verify it won't break other usecases.
-1. All good? Commit and push to GitHub, and submit a pull request.