mirror of https://github.com/rusefi/msqur.git
Cleanup. rm greentext, improve about/readme/etc
This commit is contained in:
Nick
parent
997230e426
commit
be824f9ae5
12
README.md
12
README.md
|
|
@ -56,6 +56,18 @@ If you'd like to run a copy to develop yourself, read the [Installation](#Instal
|
|||
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
|
||||
|
|
|
|||
|
|
@ -22,23 +22,25 @@ $msqur->header();
|
|||
?>
|
||||
<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();
|
||||
?>
|
||||
|
|
|
|||
|
|
@ -14,25 +14,25 @@ GNU General Public License for more details.
|
|||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
||||
|
||||
* {
|
||||
body, button {
|
||||
font-family: "Verdana", sans-serif;
|
||||
}
|
||||
|
||||
div.error {
|
||||
color: red;
|
||||
color: darkred;
|
||||
}
|
||||
|
||||
div.warn, div.warning {
|
||||
color: orange;
|
||||
color: darkorange;
|
||||
}
|
||||
|
||||
div.info {
|
||||
color: green;
|
||||
color: #111;
|
||||
}
|
||||
|
||||
div.debug {
|
||||
font-family: monospace !important;
|
||||
color: dark-gray;
|
||||
color: black;
|
||||
}
|
||||
|
||||
div#navigation {
|
||||
|
|
|
|||
|
|
@ -1,37 +1,23 @@
|
|||
<div class="info" id="splash">
|
||||
<h3>Overview</h3>
|
||||
<div>View MSQ files online. Upload your Tuner Studio .msq files to view and share them.</div>
|
||||
<p>View MSQ files online. Upload your Tuner Studio .msq files to view and share them.</p>
|
||||
<h3>How to use this site:</h3>
|
||||
<div>
|
||||
<section>
|
||||
<h4>To add your MSQ file to share and view online:</h4>
|
||||
<div>Click on the upload button:</div>
|
||||
<div><img class="tutorial" id="tutorial1" src="view/img/tutorial1.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
Click the "Browse" button (or area) and select the MSQ file you want to upload. Note that you can upload more than one at a time, using the same engine information for each:
|
||||
<div><img class="tutorial" id="tutorial2" src="view/img/tutorial2.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
Now enter in the engine information for the MSQ file(s):
|
||||
<div><img class="tutorial" id="tutorial3" src="view/img/tutorial3.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
Click upload, and you should see links to your MSQ file(s) if successful. You can copy (right-click and select "Copy Link Location" or something like that), or click on it to view the file.
|
||||
<div><img class="tutorial" id="tutorial4" src="view/img/tutorial4.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
Now you can browse the various sections of your MSQ file:
|
||||
<div><img class="tutorial" id="tutorial5" src="view/img/tutorial5.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
Since I don't have the configuration files for every single Megasquirt version, you might see an error like this:
|
||||
<div><img class="tutorial" id="tutorial6" src="view/img/tutorial6.png"/></div>
|
||||
</div>
|
||||
<div>
|
||||
If so, please email me (nearwood@gmail.com) with your "INI" file (msqur tries to give you a hint as to the version it needs).
|
||||
</div>
|
||||
<p>Click on the upload button:</p>
|
||||
<img class="tutorial" id="tutorial1" src="view/img/tutorial1.png"/>
|
||||
<p>Click the "Browse" button (or area) and select the MSQ file you want to upload. Note that you can upload more than one at a time, using the same engine information for each:</p>
|
||||
<img class="tutorial" id="tutorial2" src="view/img/tutorial2.png"/>
|
||||
<p>Now enter in the engine information for the MSQ file(s):</p>
|
||||
<img class="tutorial" id="tutorial3" src="view/img/tutorial3.png"/>
|
||||
<p>Click upload, and you should see links to your MSQ file(s) if successful. You can copy (right-click and select "Copy Link Location" or something like that), or click on it to view the file.</p>
|
||||
<img class="tutorial" id="tutorial4" src="view/img/tutorial4.png"/>
|
||||
<p>Now you can browse the various sections of your MSQ file:</p>
|
||||
<img class="tutorial" id="tutorial5" src="view/img/tutorial5.png"/>
|
||||
<p>Since I don't have the configuration files for every single Megasquirt version, you might see an error like this:</p>
|
||||
<img class="tutorial" id="tutorial6" src="view/img/tutorial6.png"/>
|
||||
</section>
|
||||
<p>If so, please email me (nearwood@gmail.com) with your "INI" file (msqur tries to give you a hint as to the version it needs).</p>
|
||||
<h3>Developers</h3>
|
||||
<div>
|
||||
Interested in contributing? Check out msqur's <a href="https://github.com/nearwood/msqur">repository</a>. Msqur's source is licensed under the GPL.
|
||||
</div>
|
||||
<p>Interested in contributing? Check out msqur's <a href="https://github.com/nearwood/msqur">repository</a>. Msqur's source is licensed under the GPL.</p>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue