changeset 495:e6141a238811

A bit more Help
author Chris Cannam
date Thu, 18 Aug 2011 17:13:04 +0100
parents 41a156d439d0
children fb95d70c80d5
files easyhg.qrc help/a-10.html help/a-11.html help/generate.sh help/images/openfolder.png help/images/openfolder50.png help/topics.html help/topics/10.txt help/topics/11.txt
diffstat 9 files changed, 66 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/easyhg.qrc	Thu Aug 18 16:37:27 2011 +0100
+++ b/easyhg.qrc	Thu Aug 18 17:13:04 2011 +0100
@@ -28,7 +28,9 @@
 	<file>help/help.css</file>
 	<file>help/a-04.html</file>
 	<file>help/a-10.html</file>
+	<file>help/a-11.html</file>
 	<file>help/images/openremote50.png</file>
+	<file>help/images/openfolder50.png</file>
 	<file>easyhg.py</file>
 	<file>easyhg_en.qm</file>
     </qresource>
--- a/help/a-10.html	Thu Aug 18 16:37:27 2011 +0100
+++ b/help/a-10.html	Thu Aug 18 17:13:04 2011 +0100
@@ -14,19 +14,19 @@
 repository from the remote URL into a folder on your own computer.  To
 do this,</p>
 
-<p><b>1. click the Open toolbar button or use File -> Open</b></p>
+<p><b>1. Click the Open toolbar button or use File -> Open</b></p>
 
 <p><center><img src="images/openremote50.png"></center></p>
 
-<p><b>2. select &ldquo;Remote Repository&rdquo; as the thing you want to open</b></p>
+<p><b>2. Select &ldquo;Remote repository&rdquo; as the thing you want to open</b></p>
 
-<p><b>3. enter the repository URL into the URL field</b></p>
+<p><b>3. Enter the repository URL into the URL field</b></p>
 
-<p><b>4. give the name of a folder on your local computer to clone into</b> &ndash;
+<p><b>4. Give the name of a folder on your local computer to clone into</b> &ndash;
  this folder will be created for you, so it shouldn't be one that already
  exists</p>
 
-<p><b>5. click OK</b></p>
+<p><b>5. Click OK</b></p>
 
 <p>If the remote repository has restricted access, you may be asked to
 provide a username and password to log in to the server it is hosted
@@ -34,6 +34,6 @@
 data to be transferred.</p>
 
 <p>Provided the clone has been successful, you should now have a local
-repository to work in.</p>
-
+repository to start working in.
+<ul><li>Note: the equivalent Mercurial command for this is <b>hg clone</b></li></ul>
 <hr><p><a href="topics.html">Back to Topics</a></p>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/a-11.html	Thu Aug 18 17:13:04 2011 +0100
@@ -0,0 +1,24 @@
+<link rel="stylesheet" type="text/css" href="help.css"/>
+<p><a href="topics.html">Back to Topics</a></p><hr>
+
+
+<h2>I have a folder of source code or documents on my computer and I want to use version control to manage it</h2>
+
+<p>To start using version control for a project folder, you need to
+initialise a repository there.  </p>
+
+<p><b>1. Click the Open toolbar button or use File -> Open</b></p>
+
+<p><center><img src="images/openfolder50.png"></center></p>
+
+<p><b>2. Select &ldquo;File folder&rdquo; as the thing you want to open</b></p>
+
+<p><b>3. Browse to your folder</p>
+
+<p></b>4. Click OK*</p>
+
+<p>A new repository will be created, stowed into the working folder you
+selected.  It will have an empty history, until you add and commit
+some files.
+<ul><li>Note: the equivalent Mercurial command for this is <b>hg init</b></li></ul>
+<hr><p><a href="topics.html">Back to Topics</a></p>
--- a/help/generate.sh	Thu Aug 18 16:37:27 2011 +0100
+++ b/help/generate.sh	Thu Aug 18 17:13:04 2011 +0100
@@ -23,7 +23,7 @@
 s/^\s+\*\s+(.*)$/<ul><li>$1<\/li><\/ul>/gm;
 s/"([\w])/&ldquo;$1/gs;
 s/([\w])"/$1&rdquo;/gs;
-s/^\#([^\s]+)$/<center><img src="images\/$1"><\/center>/gm;
+s/^\#([^\s]+)$/<center><img src="images\/$1.png"><\/center>/gm;
 s/\n-+\n/\n/gs;
 s/\n\n([^\n])/\n\n<p>$1/gs;
 s/^\n*([^<\n])/\n<p>$1/gs;
@@ -48,6 +48,7 @@
 
     if [ "$category" != "$pcat" ]; then
 	echo "<h3>$category</h3>" >> topics.html
+	pcat="$category"
     fi
 
     grep '<h2>' "$out" | sed "s|<h2>|<p><a href=\"$out\">|" | sed 's/<\/h2>/<\/a><\/p>/' >> topics.html
Binary file help/images/openfolder.png has changed
Binary file help/images/openfolder50.png has changed
--- a/help/topics.html	Thu Aug 18 16:37:27 2011 +0100
+++ b/help/topics.html	Thu Aug 18 17:13:04 2011 +0100
@@ -7,3 +7,4 @@
 <p><a href="a-04.html">What is a repository?</a></p>
 <h3>Opening and initialising things</h3>
 <p><a href="a-10.html">Someone gave me a repository URL and asked me to clone it</a></p>
+<p><a href="a-11.html">I have a folder of source code or documents on my computer and I want to use version control to manage it</a></p>
--- a/help/topics/10.txt	Thu Aug 18 16:37:27 2011 +0100
+++ b/help/topics/10.txt	Thu Aug 18 17:13:04 2011 +0100
@@ -14,9 +14,9 @@
 
 *1. Click the Open toolbar button or use File -> Open*
 
-#openremote50.png
+#openremote50
 
-*2. Select "Remote Repository" as the thing you want to open*
+*2. Select "Remote repository" as the thing you want to open*
 
 *3. Enter the repository URL into the URL field*
 
@@ -32,5 +32,6 @@
 data to be transferred.
 
 Provided the clone has been successful, you should now have a local
-repository to work in.
+repository to start working in.
 
+ * Note: the equivalent Mercurial command for this is *hg clone*
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help/topics/11.txt	Thu Aug 18 17:13:04 2011 +0100
@@ -0,0 +1,26 @@
+{Opening and initialising things}
+
+I have a folder of source code or documents on my computer and I want to use version control to manage it
+
+To start using version control for a project folder, you need to
+initialise a repository there.  
+
+*1. Click the Open toolbar button or use File -> Open*
+
+#openfolder50
+
+*2. Select "File folder" as the thing you want to open*
+
+*3. Browse to your folder*
+
+*4. Click OK*
+
+A new repository will be created, stowed into the working folder you
+selected.  At first, it will have an empty history.  You can then
+start to add and commit changes to your files.
+
+(You will need to "add" files before you can start to track changes to
+them.  The default is for all files in the folder to be treated as
+"untracked", i.e. not included in the history.)
+
+ * Note: the equivalent Mercurial command for this is *hg init*