Merge pull request #28 from nearwood/master

v1.51

README.md

@@ -1,25 +1,48 @@
 # MSQur
 
-'Masker' I guess? Supposed to be a play on imgur.
 MegaSquirt MSQ file sharing and viewing site.
 
+Pronounced 'masker' I guess? Supposed to be a play on imgur.
+
 Parses MSQ "XML" in tandem with an associated INI (config) file and displays it in a familiar format for viewing and comparing.
 
-Try it now at: https://msqur.com/
+Try it now at: https://msqur.com
 
 ### Build Status:
-* msqur.com [![Build Status](https://travis-ci.org/nearwood/msqur.svg?branch=msqur.com)](https://travis-ci.org/nearwood/msqur)
+* [msqur.com](https://msqur.com) [![Build Status](https://travis-ci.org/nearwood/msqur.svg?branch=msqur.com)](https://travis-ci.org/nearwood/msqur)
 * master [![Build Status](https://travis-ci.org/nearwood/msqur.svg?branch=master)](https://travis-ci.org/nearwood/msqur)
 
+## Development status
+
+Firmware support:
+
+ - [ ] MS1
+ - [ ] MSnS-extra (partial)
+ - [x] MS2
+ - [x] MS2Extra
+ - [x] MS3
+ - [ ] Speeduino
+
+## Contributing
+
+This is basically a one-man operation. I welcome any contributions: code, styles, text content, or simply spelling & grammar.
+If you're interesting in helping out, please first take a look at the existing [issues](issues) and see if you can offer any assistance with them.
+If you don't see your issue or new idea listed there you can [create a new issue](issues/new). Please be detailed.
+
+If you'd like to run a copy to develop yourself, read the [Installation](#Installation) section below.
+
 ### Installation
 
 #### Needed software
 
-* MariaDB, PHP
-* PDO extension for PHP.
+- PHP 7.x with the following extensions:
+  - PDO
+  - OpenSSL
+- MySQL/MariaDB
 
-#### Recommended software
+#### Optional software
 
+* Web server (Apache/nginx/etc.)
 * phpMyAdmin - For managing the DB
 
 #### Development Setup
@@ -33,6 +56,18 @@ Try it now at: https://msqur.com/
 1. Update DB with update scripts in sequential order (patse into phpMyAdmin or piped to `sqlcmd`, etc.)
 1. Hit webserver to start using it (eg. `php -S`, etc.)
 
+### Source tree description
+
+* `db` - Database scripts
+* `doxygen` - Doxygen configuration and generated code documentation
+* `src` - PHP source
+  * `ini` - Megasquirt configuration files
+  * `view` - PHP/JS frontend source
+    * `lib` - JS 3rd party libraries
+    * `img` - Static images
+  * `tests` - PHP Unit Tests (TODO)
+
+
 ### Update & Deployment Instructions
 
 > These steps are outdated
@@ -48,13 +83,13 @@ msqur is licensed under the GPL v3.0. A copy of this license is included in the
 
 ### Who do I talk to?
 
-* Nicholas Earwood
+* Nick
 * [email protected]
 * https://nearwood.dev/
 
 ### Credits
 
-[CamHenlin](https://github.com/CamHenlin)
+* [CamHenlin](https://github.com/CamHenlin)
 
 > This section needs to be updated
 

deploy.sh

@@ -1,6 +1,6 @@
 #. script.config
 
-mkdir -p ~\/.ssh
+# mkdir -p ~/.ssh
 openssl aes-256-cbc -K $encrypted_571de2096706_key -iv $encrypted_571de2096706_iv -in .travis/travis_ci.enc -out .travis/id_rsa -d
 
 eval "$(ssh-agent -s)"

src/about.php

@@ -22,23 +22,25 @@
 ?>
 <div>
 	<h2>About</h2>
-	<p>Created out of a need to share .MSQ files.
-	I was tired of downloading files and having to open them in <strike>MegaTune</strike> Tuner Studio.
-	So, I created this site. It's open source, so <a href="https://github.com/nearwood/msqur">feel free to contribute</a>.
-	Since going "live" I only add things here and there whenever I have time or the urge to add features/fixes.</p>
+	<p>Created out of a need to share .MSQ files.</p>
+	<p>I was tired of downloading files and having to open them in <strike>MegaTune</strike> Tuner Studio, so I created this site.</p>
+	<p>It's open source, so <a href="https://github.com/nearwood/msqur">anyone can contribute</a>.</p>
+	<p>Since going "live" I only add things here and there whenever I have time or the urge to add features/fixes.</p>
 </div>
 <div>
 	<h2>FAQ</h2>
 	<ul id="faq">
 		<li class="q">Why is this site so ugly?</li>
-		<li class="a">My Ballmer peak doesn't last all day.</li>
+		<li class="a">It's a side project and my <a href="https://www.xkcd.com/323/">Ballmer Peak</a> doesn't last all day.</li>
 		<li class="q">Can you add X feature?</li>
 		<li class="a">File a request for it <a href="https://github.com/nearwood/msqur/issues">here</a>.</li>
+		<li class="q">What tech stack does this site run on?</li>
+		<li class="a">The frontend is Javascript (jQuery and a little Angular.js).<br/>The backend that does most of the work was made with PHP and data is stored in a SQL database.</li>
 	</ul>
 </div>
-<div>
-	<?php if (@readfile("VERSION") === FALSE) echo "DEV"; ?> <a href="http://httpd.apache.org/">Apache</a> <a href="http://php.net/">PHP</a> <a href="https://angularjs.org/">AngularJS</a> <a href="http://jquery.com/">jQuery</a>
-</div>
+<h6 style="float: right;">
+	Version: <?php if (@readfile("VERSION") === FALSE) echo "DEV"; ?>
+</h6>
 <?php
 $msqur->footer();
 ?>

src/browse.php

@@ -88,11 +88,11 @@
 
 echo '<div id="content"><div class="info">' . $numResults . ' results.</div>';
 echo '<table ng-controller="BrowseController">';
-echo '<tr><th>ID</th><th>Download</th><th>Engine Make</th><th>Engine Code</th><th>Cylinders</th><th>Liters</th><th>Compression</th><th>Aspiration</th><th>Firmware/Version</th><th>Upload Date</th><th>Views</th></tr>';
+echo '<tr><th>Uploaded</th><th>Engine Make</th><th>Engine Code</th><th>Cylinders</th><th>Liters</th><th>Compression</th><th>Aspiration</th><th>Firmware/Version</th><th>Views</th><th>Options</th></tr>';
 for ($c = 0; $c < $numResults; $c++)
 {
 	$aspiration = $results[$c]['induction'] == 1 ? "Turbo" : "NA";
-	echo '<tr><td><a href="view.php?msq=' . $results[$c]['mid'] . '">' . $results[$c]['mid'] . '</a></td><td><a href="download.php?msq=' . $results[$c]['mid'] . '">💾</a></td><td>' . $results[$c]['make'] . '</td><td>' . $results[$c]['code'] . '</td><td>' . $results[$c]['numCylinders'] . '</td><td>' . $results[$c]['displacement'] . '</td><td>' . $results[$c]['compression'] . ':1</td><td>' . $aspiration . '</td><td>' . $results[$c]['firmware'] . '/' . $results[$c]['signature'] . '</td><td>' . $results[$c]['uploadDate'] . '</td><td>' . $results[$c]['views'] . '</td></tr>';
+	echo '<tr><td><a href="view.php?msq=' . $results[$c]['mid'] . '">' . $results[$c]['uploadDate'] . '</a></td><td>' . $results[$c]['make'] . '</td><td>' . $results[$c]['code'] . '</td><td>' . $results[$c]['numCylinders'] . '</td><td>' . $results[$c]['displacement'] . '</td><td>' . $results[$c]['compression'] . ':1</td><td>' . $aspiration . '</td><td>' . $results[$c]['firmware'] . '/' . $results[$c]['signature'] . '</td><td>' . $results[$c]['views'] . '</td><td><a title="Download MSQ" href="download.php?msq=' . $results[$c]['mid'] . '">💾</a></td></tr>';
 }
 echo '</table></div>';