View unanswered posts | View active topics It is currently Thu Jan 21, 2021 12:51 pm



Reply to topic  [ 2 posts ] 
MegaTunix Required Documentation Blocks 
Author Message
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15376
Location: Home sweet home!
I was thinking about MTX and what it needs, this is surely a partial list, but...

0) Web summary and sales pitch

1) User guide with instructions on what various things do and how to achieve results etc. Maybe this can be single source and parsed into or from tooltip data. It'd be a shame to duplicate that and have one version or both end up wrong.

2) Source code docs, doxy, automated, no problems.

3) Building from source code, prereqs and stuff on/for different system styles such as ports, fink, deb, ubunt, arch, fedora, winblows (X build), for debian that could be reduced to "git clone X;cd MegaTunix;dpkg -i dependencies-ubuntu.deb;contrib/buildStuff.bash" if you build a meta package and keep deb/ubunt/whatever in the source repo taht can be installed and pull in the appropriate prereqs automatically.

4) Which systems it supports and which versions/ranges of firmware it supports, such as:

MS1 B&G XYZ-ABC
MS1Extra VWZ-UIO
MS2 B&G QWE-RTY
MS2Extra 3.1.0-3.1.2, 3.2.0, etc
FreeEMS <latest from master sources only, no backward compatibility yet>
MS3, nothing yet.
PIS, disabled, may work, may not.
JimStim 2.0.3

And limitations for any of them, such as "datalogging, bench test, some accessories and 3 table tuning only" for FreeEMS, etc.

If this is up to date at release time, it can stay with a release into the future as a reference.

5) Hazards of installing released versions (miles out of date usually) but how to get each of them anyway.

Maybe more!

Fred.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Tue Dec 06, 2011 9:17 pm
Profile WWW
Moderator
User avatar

Joined: Tue Jan 15, 2008 2:31 pm
Posts: 15376
Location: Home sweet home!
Additionally a tweaking guide explaining what the different sets of installed files relate to and how they can be changed to customise various things! I write this as I contemplate tweaking something and don't know where to start :-) I'll find it, no stress.

_________________
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!


Wed Dec 07, 2011 1:36 pm
Profile WWW
Display posts from previous:  Sort by  
Reply to topic   [ 2 posts ] 

Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
cron
Powered by phpBB® Forum Software © phpBB Group
Designed by ST Software for PTF. ColorizeIt.