Changes between Version 2 and Version 3 of SourceCode

Timestamp:

Jan 24, 2017, 5:54:30 PM (9 years ago)

Author:

Greg Couch

Comment:

--

SourceCode

@@ -1 +1 @@
 = Getting ChimeraX source code =
 
-To get the ChimeraX source code from the git repository use
+ChimeraX uses [https://git-scm.com/ git] for its revision control system.
 
-{{{git clone ssh://plato.cgl.ucsf.edu/usr/local/projects/chimerax/git/chimerax}}}
+== Configuring git ==
 
-The nightly build scripts are in a separate repository:
+Git associates a user name and email address with all check-ins. The defaults are based on your USERNAME and your computer’s hostname. The email address is usually wrong. To explicitly set those values:
+{{{
+git config --global user.name "Your Name"
+git config --global user.email you@example.com
+}}}
+If you have multiple email addresses (or names) and multiple git repositories you are working on, you can set the values on a per-repository.
 
-{{{git clone ssh://plato.cgl.ucsf.edu/usr/local/projects/chimerax/git/build_tools}}}
+== Obtaining ChimeraX Source Code ==
+
+To get the ChimeraX source code from the git repository use:
+{{{
+git clone --depth 1 --single-branch --branch develop plato.cgl.ucsf.edu:/usr/local/projects/chimerax/git/chimerax.git
+}}}
+For the full revision history, omit the {{{--depth 1}}} argument (and download many more Megabytes).
+
+== Nightly Builds ==
+
+The nightly build scripts are in a separate repository because they contain private information (//e.g.//, code signing keys) and should not be shared with outside developers.  If there is something, you'd like to make public, then it should be in the ChimeraX repository.
+
+{{{
+git clone ssh://plato.cgl.ucsf.edu/usr/local/projects/chimerax/git/build_tools
+}}}