From 7af576396a2e56c8fce7299a41a40197fb08c2d5 Mon Sep 17 00:00:00 2001
From: Enar Vaikene <enar@vaikene.net>
Date: Tue, 27 Sep 2011 15:51:13 +0300
Subject: [PATCH] Added the preparations section. Added links to next and
previous pages to the top of tutorial pages.
---
www/evaf.css | 4 ++++
www/pswgen01.html | 2 ++
www/pswgen02.html | 49 ++++++++++++++++++++++++++++++++++++++++++++++-
www/pswgen03.html | 1 +
www/pswgen04.html | 2 ++
www/pswgen05.html | 2 ++
www/pswgen06.html | 2 ++
www/pswgen07.html | 2 ++
www/pswgen08.html | 2 ++
www/pswgen09.html | 2 ++
www/pswgen10.html | 2 ++
www/pswgen11.html | 2 ++
12 files changed, 71 insertions(+), 1 deletion(-)
diff --git a/www/evaf.css b/www/evaf.css
index ad5f778..2f09074 100644
--- a/www/evaf.css
+++ b/www/evaf.css
@@ -37,3 +37,7 @@ p {
p.main {
text-align: justify;
}
+tt {
+ color: blue;
+}
+
diff --git a/www/pswgen01.html b/www/pswgen01.html
index 4bc5917..ed98031 100644
--- a/www/pswgen01.html
+++ b/www/pswgen01.html
@@ -11,6 +11,8 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen02.html">02 - Preparations</a></p>
<h1>eVaf Tutorial</h1>
diff --git a/www/pswgen02.html b/www/pswgen02.html
index 021c93e..f066dbd 100644
--- a/www/pswgen02.html
+++ b/www/pswgen02.html
@@ -11,12 +11,59 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen03.html">03 - Generator Module</a>, Previous: <a href="pswgen01.html">01 - Introduction</a></p>
<h1>eVaf Tutorial</h1>
<h2>02 - Preparations</h2>
+
+ <h3>Getting eVaf sources</h3>
+
+ <p>eVaf uses <a href="http://git-scm.com">git</a> as the version control system. If you don't have it installed
+ yet, install it now.</p>
+
+ <p>Then open your favorite terminal program and go to the root directory for all your development projects.
+ Clone the eVaf repository using the following command:</p>
+
+ <pre> $ <code>git clone http://www.vaikene.net/git/evaf</code></pre>
+
+ <p>This command downloads evaf sources into the sub-directory <tt>evaf</tt>.</p>
+
+ <h3>Qt, CMake, gcc</h3>
+
+ <p>Make sure that you have Qt version 4.6 and CMake version 2.6 or newer versions installed. If not, install
+ them now.</p>
+
+ <p>The tutorial code is tested with gcc versions 4.4, 4.5 and 4.6.</p>
+
+ <h3>Existing PswGen application</h3>
+
+ <p>The code that we write in this tutorial already exists in the <tt>src/apps/PswGen</tt> directory. Delete
+ or rename the existing PswGen application if you want to follow the tutorial and write a new application.
+ Then create a new sub-directory called <tt>PswGen</tt> in the <tt>src/apps</tt> directory.</p>
+
+ <h3>If you are running Windows</h3>
+
+ <p>If you happen to be running Windows instead of Linux, then you still need git, CMake and Qt installed.
+ The tutorial code is tested with Visual C++ 2010 Express and Visual Studio 2005 Professional editions.
+ Use the <tt>Git Bash</tt> command prompt to clone the repository.</p>
+
+ <p>The code is fully portable and needs no changes to build on Windows. However, build commands itself
+ have to be modified:</p>
+
+ <ol>
+ <li>Use the <tt>Visual Studio NNNN Command Prompt</tt> to run build commands. Make sure that Qt and CMake
+ binaries are in the path inside the command prompt;</li>
+ <li>When running <tt>cmake</tt>, add the <tt>-G "NMake Makefiles"</tt> option to the
+ <tt>cmake</tt> command;</li>
+ <li>Use <tt>nmake</tt> command instead of <tt>make</tt>.</li>
+ </ol>
+
+ <p>eVafGUI.exe command line options with directory names like <tt>--dataroot=<path></tt> expect
+ '/' as the directory separator even when running on Windows.</p>
- <p>In the next section <a href="pswgen03.html">03 - Generator Module</a> we write the Generator module.</p>
+ <p>In the next section <a href="pswgen03.html">03 - Generator Module</a> we start writing the Generator module.</p>
</body>
diff --git a/www/pswgen03.html b/www/pswgen03.html
index 88ec130..a4bd834 100644
--- a/www/pswgen03.html
+++ b/www/pswgen03.html
@@ -13,6 +13,7 @@
<body>
+ <p>Next: <a href="pswgen04.html">04 - Generator Module</a>, Previous: <a href="pswgen02.html">02 - Preparations</a></p>
<h1>eVaf Tutorial</h1>
<h2>03 - Generator Module</h2>
diff --git a/www/pswgen04.html b/www/pswgen04.html
index bf88046..63a9df2 100644
--- a/www/pswgen04.html
+++ b/www/pswgen04.html
@@ -13,6 +13,8 @@
<body>
+ <p>Next: <a href="pswgen05.html">05 - Building Generator Module</a>, Previous: <a href="pswgen03.html">03 - Generator Module</a></p>
+
<h1>eVaf Tutorial</h1>
<h2>04 - Generator Module</h2>
diff --git a/www/pswgen05.html b/www/pswgen05.html
index d84504d..3db173b 100644
--- a/www/pswgen05.html
+++ b/www/pswgen05.html
@@ -13,6 +13,8 @@
<body>
+ <p>Next: <a href="pswgen06.html">06 - Storage Module</a>, Previous: <a href="pswgen04.html">04 - Generator Module</a></p>
+
<h1>eVaf Tutorial</h1>
<h2>05 - Building Generator Module</h2>
diff --git a/www/pswgen06.html b/www/pswgen06.html
index 6c7ea93..ad523d7 100644
--- a/www/pswgen06.html
+++ b/www/pswgen06.html
@@ -12,6 +12,8 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen07.html">07 - Storage Module</a>, Previous: <a href="pswgen05.html">05 - Building Generator Module</a></p>
<h1>eVaf Tutorial</h1>
diff --git a/www/pswgen07.html b/www/pswgen07.html
index d35d484..96c6ce0 100644
--- a/www/pswgen07.html
+++ b/www/pswgen07.html
@@ -12,6 +12,8 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen08.html">08 - Building Storage Module</a>, Previous: <a href="pswgen06.html">06 - Storage Module</a></p>
<h1>eVaf Tutorial</h1>
diff --git a/www/pswgen08.html b/www/pswgen08.html
index c9802de..c00e7f2 100644
--- a/www/pswgen08.html
+++ b/www/pswgen08.html
@@ -12,6 +12,8 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen09.html">09 - GUI Module</a>, Previous: <a href="pswgen07.html">07 - Storage Module</a></p>
<h1>eVaf Tutorial</h1>
diff --git a/www/pswgen09.html b/www/pswgen09.html
index 7f05aba..44ec714 100644
--- a/www/pswgen09.html
+++ b/www/pswgen09.html
@@ -13,6 +13,8 @@
<body>
+ <p>Next: <a href="pswgen10.html">10 - GUI Module</a>, Previous: <a href="pswgen08.html">08 - Building Storage Module</a></p>
+
<h1>eVaf Tutorial</h1>
<h2>09 - GUI Module</h2>
diff --git a/www/pswgen10.html b/www/pswgen10.html
index f1ea8e1..616e321 100644
--- a/www/pswgen10.html
+++ b/www/pswgen10.html
@@ -12,6 +12,8 @@
</head>
<body>
+
+ <p>Next: <a href="pswgen11.html">11 - Building GUI Module</a>, Previous: <a href="pswgen09.html">09 - GUI Module</a></p>
<h1>eVaf Tutorial</h1>
diff --git a/www/pswgen11.html b/www/pswgen11.html
index 7fb3f32..c9fda6a 100644
--- a/www/pswgen11.html
+++ b/www/pswgen11.html
@@ -13,6 +13,8 @@
<body>
+ <p>Previous: <a href="pswgen10.html">10 - GUI Module</a></p>
+
<h1>eVaf Tutorial</h1>
<h2>11 - Buiding PswGen application</h2>
--
2.49.0