Re-build so debian.csclub include library as a dependency
[public/pyceo-broken.git] / docs / GIT-HOWTO
1 Getting the Source
2 ------------------
3
4 The sources for this project are in a git repository. Git is a distributed
5 revision control tool originally created by Linus Torvalds to track the Linux
6 kernel tree. With git, there is generally no central repository that everyone
7 commits their changes to. Instead, collaboration is done by "pulling" changes
8 from the repositories of other contributors.
9
10 When you check out the sources, you will get the entire history along with
11 the latest version. You do not need any special permissions to clone a
12 repository and start making changes.
13
14 To retrieve the ceo sources, clone the public repository:
15
16     git clone /users/git/public/pyceo.git
17
18 Making Changes
19 --------------
20
21 Now that you have your own repository, you can start making changes. You
22 may can add, update, or delete files as necessary and then commit these
23 changes to your local repository. Then you can make these changes available
24 to others. Read the documentation to learn more about basic git usage.
25
26 Git Resources
27 -------------
28
29 For a tutorial, see [1] generally and [2] if you are familiar with CVS.
30 The manpages for git are also invaluable, use `man git-foo` to view them,
31 or look online at [3].
32
33 Finally, if you're interested in how git works internally, see [4] for
34 documentation of the "core" commands, and [5] for documentation of the
35 repository format.
36
37 [1] http://www.kernel.org/pub/software/scm/git/docs/tutorial.html
38 [2] http://www.kernel.org/pub/software/scm/git/docs/cvs-migration.html
39 [3] http://www.kernel.org/pub/software/scm/git/docs/
40 [4] http://www.kernel.org/pub/software/scm/git/docs/core-tutorial.html
41 [5] http://www.kernel.org/pub/software/scm/git/docs/repository-layout.html
42
43
44 Setting up a Public Repository
45 ------------------------------
46
47 If you make changes, you will probably want to share them with the other
48 contributors. The only thing other people need to fetch your changes into
49 their own repository is the location of your repository and read access to
50 it. With that they can use `git pull` to fetch and merge your changes.
51
52 If you want to make changes but not publish them immediately after each
53 commit, create a second "public" repository and use "git push" when you
54 are ready to make your changes public. Refer to the Internet for more
55 details.