Skip to content

Commit 9322a46

Browse files
author
arokem
committed
Added gitwash documentation after using the gitwash_dumper script to search and replace gitwash => nitime
1 parent 4e2a2b3 commit 9322a46

19 files changed

+802
-104
lines changed

INSTALL

+1-89
Original file line numberDiff line numberDiff line change
@@ -1,89 +1 @@
1-
.. -*- rst -*- rest mode for emacs
2-
3-
========================
4-
Development quickstart
5-
========================
6-
7-
Source Code
8-
===========
9-
10-
NIPY uses launchpad_ for our code hosting. For immediate access to
11-
the source code, see the `nipy launchpad`_ site.
12-
13-
Guidelines
14-
==========
15-
16-
We have adopted many developer guidelines in an effort to make
17-
development easy, and the source code readable, consistent and robust.
18-
Many of our guidelines are adopted from the scipy_ / numpy_ community.
19-
We welcome new developers to the effort, if you're interested in
20-
developing code or documentation please join the `nipy mailing list`_
21-
and introduce yourself. If you plan to do any code development, we
22-
ask that you take a look at the following guidelines. We do our best
23-
to follow these guidelines ourselves:
24-
25-
* :ref:`howto_document` : Documentation is critical. This document
26-
describes the documentation style, syntax, and tools we use.
27-
28-
* `Numpy/Scipy Coding Style Guidelines:
29-
<http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines>`_
30-
This is the coding style we strive to maintain.
31-
32-
* :ref:`bzr_workflow` : This describes our process for version control.
33-
34-
* :ref:`testing` : We've adopted a rigorous testing framework.
35-
36-
* :ref:`optimization`: "premature optimization is the root of all
37-
evil."
38-
39-
.. _trunk_download:
40-
41-
Checking out the latest version
42-
===============================
43-
44-
To check out the latest version of nipy you need bzr version greater than
45-
0.92::
46-
47-
bzr branch lp:nipy
48-
49-
There are two methods to install a development version of nipy. For
50-
both methods, build the extensions in place::
51-
52-
python setup.py build_ext --inplace
53-
54-
Then you can either:
55-
56-
#. Use the ``mynipy`` script in the tools directory of the nipy
57-
source. There are directions and examples in the docstring of that
58-
file, but basically it updates a symbolic link in your
59-
*site-packages* directory to the inplace build of your source. The
60-
advantage of this method is it does not require any modifications of
61-
your PYTHONPATH.
62-
63-
#. Place the source directory in your PYTHONPATH.
64-
65-
With either method, all of the modifications made to your source tree
66-
will be picked up when nipy is imported.
67-
68-
69-
Submitting a patch
70-
==================
71-
72-
The preferred method to submit a patch is to create a branch of nipy on
73-
your machine, modify the code and push that branch to your launchpad
74-
directory. Then email the list and we will review your code and
75-
hopefully apply (merge) your patch. See the instructions for
76-
:ref:`init_trunk_dev`.
77-
78-
If you do not wish to use bazaar and launchpad, please feel free to
79-
file a bug report and submit a patch or email the `nipy mailing
80-
list`_.
81-
82-
Bug reports
83-
===========
84-
85-
If you find a bug in nipy, please submit a bug report at the `nipy
86-
bugs`_ launchpad site so that we can fix it.
87-
88-
89-
.. include:: doc/links_names.txt
1+
For installation instructions see documentation

doc/devel/branch_list.png

13 KB
Loading

doc/devel/branch_list_compare.png

10.4 KB
Loading

doc/devel/configure_git.rst

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.. _configure-git:
2+
3+
===============
4+
Configure git
5+
===============
6+
7+
.. _git-config-basic:
8+
9+
Overview
10+
========
11+
12+
::
13+
14+
git config --global user.email [email protected]
15+
git config --global user.name "Your Name Comes Here"
16+
17+
18+
In detail
19+
=========
20+
21+
This is to tell git_ who you are, for labeling any changes you make to
22+
the code. The simplest way to do this is from the command line::
23+
24+
git config --global user.email [email protected]
25+
git config --global user.name "Your Name Comes Here"
26+
27+
This will write the settings into your git configuration file - a file
28+
called ``.gitconfig`` in your home directory.
29+
30+
Advanced git configuration
31+
==========================
32+
33+
You might well benefit from some aliases to common commands.
34+
35+
For example, you might well want to be able to shorten ``git checkout`` to ``git co``.
36+
37+
The easiest way to do this, is to create a ``.gitconfig`` file in your
38+
home directory, with contents like this::
39+
40+
[core]
41+
editor = emacs
42+
[user]
43+
44+
name = Your Name Comes Here
45+
[alias]
46+
st = status
47+
stat = status
48+
co = checkout
49+
[color]
50+
diff = auto
51+
status = true
52+
53+
(of course you'll need to set your email and name, and may want to set
54+
your editor). If you prefer, you can do the same thing from the command
55+
line::
56+
57+
git config --global core.editor emacs
58+
git config --global user.email [email protected]
59+
git config --global user.name "Your Name Comes Here"
60+
git config --global alias.st status
61+
git config --global alias.stat status
62+
git config --global alias.co checkout
63+
git config --global color.diff auto
64+
git config --global color.status true
65+
66+
These commands will write to your user's git configuration file
67+
``~/.gitconfig``.
68+
69+
To set up on another computer, you can copy your ``~/.gitconfig`` file,
70+
or run the commands above.
71+
72+
Other configuration recommended by Yarik
73+
========================================
74+
75+
In your ``~/.gitconfig`` file alias section::
76+
77+
wdiff = diff --color-words
78+
79+
so that ``git wdiff`` gives a nicely formatted output of the diff.
80+
81+
To enforce summaries when doing merges(``~/.gitconfig`` file again)::
82+
83+
[merge]
84+
summary = true
85+
86+
87+
.. include:: git_links.txt
88+
89+

doc/devel/development_quickstart.rst

-1
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
.. include:: ../../INSTALL

0 commit comments

Comments
 (0)