Added install instructions for git install.
[emufront] / www / index.html
index 05507ea..5c96e8b 100644 (file)
@@ -7,7 +7,7 @@
                <meta name="description" content="EmuFront is an universal (multi-system) computer and video game console emulator front-end implemented in QT, C++ and SQLite targeted on Linux operating systems. " />
                <meta name="author" content="Mikko Keinänen" />
                <meta name="lang" content="en" />
-                       
+
                <title>EmuFront :: an universal emulator front-end</title>
                <link rel="stylesheet" href="style.css" type="text/css" />
        </head>
@@ -46,6 +46,9 @@
                        <li>Configure emulators (executable, command line
                        options, supported setup)</li>
                        <li>Launch emulators with disk/rom/tape-images</li>
+                       <li>Multiple configurations for single emulator</li>
+                       <li>Multiple media images can be selected to a single
+                       emulator launch command</li>
                        <li>...</li>
                </ul>
 
                        <li>UnZip 6.x from <a href="http://www.info-zip.org/">Info-ZIP</a></li>
                </ul>
 
+               <h2>Installing from git repository</h2>
+
+               <pre>
+                       git clone https://vcs.maemo.org/git/emufront
+                       cd emufront/src
+                       qmake -project
+                       qmake emufront.pro
+                       make
+                       ./emufront
+               </pre>
+
                <h2>Instructions</h2>
                <ul>
+                       <li>Set the directory path for temporary files</li>
                        <li>Add platform(s) (e.g. Colecovision)</li>
                        <li>Add media type(s) (e.g. Cartridge) </li>
                        <li>Add setup(s): Assign a media type to platform and
-                       set supported file extensions (e.g. col, zipped files are
-                       supported)</li>
-                       <li>Assign path to files with setup, select path scan
-                       the files</li>
-                       <li>Configure emulator: in the command parameters $1
-                       is a placeholder for filename, this is obligatory
-                       (multiple files are also supported, e.g. -diska $1
-                       -diskb $2 ...)</li>
+                       set supported file extensions (e.g. 'dsk')</li>
+                       <li> <ul>
+                               <li>Currently only zipped files are
+                               supported.</li>
+                               <li>All the files inside a zip archive with extensions configured by user
+                               will be scanned to database</li>
+                               <li>A Zip archive can contain 1...<i>n</i> files</li>
+                               <li>If no extensions are configured for
+                       setup, the zip archive will be used AS IS with
+                       emulator configuration (this is useful with M.A.M.E.
+                       and similar emulators)</li>
+                       </ul></li>
+                       <li>Assign a file path with media images (roms, disk images) to setup</li>
+                       <li>Select an assidned file path and push scan to scan the files to database</li>
+                       <li>Configure emulator(s)</li>
+                       <li><ul>
+                               <li>Set an unique name for each emulator
+                               configuration, one emulator can have many
+                               configurations with different names</li>
+                               <li>Set the emulator executable or path to
+                               executable if the exutable is not on the
+                               system path</li>
+                               <li>Set the command line options</li>
+                               <li><ul>
+                               <li>$1 is a placeholder for filename in the command parameters, this is <b>obligatory</b></li>
+                               <li>Multiple files are also supported using placeholders $1 ... $<i>n</i>, e.g. '-diska $1 -diskb $2'</li>
+                       </ul></li>
+                       </ul></li>
                        <li>In the main window select a platform and a media
-                       type, press update, selected file(s), emulator and press
+                       type, press update, select file(s), emulator and press
                        launch</li>
+                       <li>Multiple files can be selected and they all will
+                       be extracted to /tmp/</li>
                        <li>More detailed instructions will be added later...</li>
                </ul>
 
-               <h2>Screenshots</h3>
-               
+               <h2>Screenshots</h2>
+
+               <h3>v0.0.1.4</h4>
+               <h4>PC UI/Configuring emulator with multiple disk drives</h4>
+               <p>
+                       <img src="img/emufront-0.1.4-pc-1.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
+                       <img src="img/emufront-0.1.4-pc-2.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
+                       <img src="img/emufront-0.1.4-pc-3.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
+                       <img src="img/emufront-0.1.4-pc-4.png" alt="v0.0.4a PC UI Configuring emulator with 2 disk drives" />
+               </p>
+               <h4>PC UI/Zip archive container multiple disk images and
+                       emulator configuration supporting multiple drives</h4>
+               <p>
+                       <img src="img/emufront-0.1.4-pc-5.png" alt="v0.0.4a PC UI Zip archive with multiple disk images" />
+               </p>
                <h3>v0.01a</h3>
                <h4>Maemo on N900</h4>
-               <img src="img/emufront001-maemo-01.png" alt="v0.01a Maemo N900" />
+               <p><img src="img/emufront001-maemo-01.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-02.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-03.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-04.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-11.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-12.png" alt="v0.01a Maemo N900" />
                <img src="img/emufront001-maemo-13.png" alt="v0.01a Maemo N900" />
-               <img src="img/emufront001-maemo-14.png" alt="v0.01a Maemo N900" />
+               <img src="img/emufront001-maemo-14.png" alt="v0.01a Maemo N900" /></p>
                <h3>v0.00a</h3>
                <h4>PC UI/Scanning media images</h4>
-               <img src="img/emufrontv06-1.png" alt="v0.1 PC UI" />
+               <p><img src="img/emufrontv06-1.png" alt="v0.1 PC UI" /></p>
                <h3>v0.01a</h3>
                <h4>PC UI/Main window</h4>
-               <img src="img/emufrontv01-1.png" alt="v0.1 PC UI" />
-
+               <p><img src="img/emufrontv01-1.png" alt="v0.1 PC UI" /></p>
                <hr />
 
                <p>EmuFront &copy; 2010 Mikko Keinänen</p>