]> vaikene.ee Git - evaf/blobdiff - www/pswgen02.html
Added the preparations section.
[evaf] / www / pswgen02.html
index 021c93ebe7a05fb708f0fbdace1c4e1c50e0056c..f066dbd0a5219f6fdc049ddd1c38e67e5b6e44d1 100644 (file)
     </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>