]> vaikene.ee Git - evaf/commitdiff
projects / evaf / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: f443e47)
Added the preparations section.
authorEnar Vaikene <enar@vaikene.net>
Tue, 27 Sep 2011 12:51:13 +0000 (15:51 +0300)
committerEnar Vaikene <enar@vaikene.net>
Tue, 27 Sep 2011 12:51:13 +0000 (15:51 +0300)
Added links to next and previous pages to the top of tutorial pages.

12 files changed:
www/evaf.css patch | blob | history
www/pswgen01.html patch | blob | history
www/pswgen02.html patch | blob | history
www/pswgen03.html patch | blob | history
www/pswgen04.html patch | blob | history
www/pswgen05.html patch | blob | history
www/pswgen06.html patch | blob | history
www/pswgen07.html patch | blob | history
www/pswgen08.html patch | blob | history
www/pswgen09.html patch | blob | history
www/pswgen10.html patch | blob | history
www/pswgen11.html patch | blob | history

diff --git a/www/evaf.css b/www/evaf.css
index ad5f7786636fde34882b59964c8a9fdfb50001be..2f090747a071c1ad056a6457cdd85dd1456cb5f5 100644 (file)
--- 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 4bc5917baa1629e37acecbf07e8dd24a70d5ddc2..ed98031280d7357af72f9a0d4a632b7f7dc45974 100644 (file)
--- 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 021c93ebe7a05fb708f0fbdace1c4e1c50e0056c..f066dbd0a5219f6fdc049ddd1c38e67e5b6e44d1 100644 (file)
--- 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 &quot;NMake Makefiles&quot;</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=&lt;path&gt;</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 88ec130d64ca47776d321d5d787d1ee3def2ee64..a4bd834943764d8cafe13ea8ab079a7af815e152 100644 (file)
--- 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 bf8804683831de7aea9766dec88bc3edf49e560e..63a9df2bd7f5df650f249a70ad9882933d008dbd 100644 (file)
--- 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 d84504d70d2e4b5467eef76466871a3283742bfd..3db173b67e7951fa67631afe5e0ebc9f19f3ace1 100644 (file)
--- 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 6c7ea93e28f6f9e9abdec3e2e85de4cdf2238026..ad523d7a787550a2197ae63d181711d9590af3a7 100644 (file)
--- 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 d35d48405ace88d2fa9aeca056c7a8d51dce1732..96c6ce0d76cc3dba61b26b6bf6b53b5bd384ba96 100644 (file)
--- 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 c9802deb7057c1b5ab3f03dbb3996ffb0445feac..c00e7f2e2977d9e838762f26817f3f6f7d542896 100644 (file)
--- 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 7f05aba9a097b3d39ab4e0c2a8c42fc43bb51601..44ec714ed5507ea375f529679f2d4a38c30f6cd3 100644 (file)
--- 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 f1ea8e16ba98cfb15d27661c20f849ef8bfffe17..616e3216ca62c501fd6049c157ea2300690ba3d0 100644 (file)
--- 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 7fb3f324ac4a4871ad3268759b07405194a9e5ab..c9fda6a63de6745d5e431ac8d35ca80e274d5dfa 100644 (file)
--- 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>
C++ cross-platform application development framework.