t.mettler/giesCANne
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #86 from adamvoss/readme

Browse Source 
Improve formatting of the README
This commit is contained in:
Collin Kidder
2017-07-24 21:10:41 -04:00
committed by GitHub
parent 2d01f695e2 e3cf32e2c2
commit ca796ed291
1 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -15
View File
@@ -8,8 +8,7 @@ capturing of canbus frames.
Really requires at a resolution of at least 1024x768. Fully multi-monitor capable. Really requires at a resolution of at least 1024x768. Fully multi-monitor capable.
You are highly recommended to use the CANDue board from EVTV: You are highly recommended to use the [CANDue board from EVTV](http://store.evtv.me/proddetail.php?prod=ArduinoDueCANBUS&cat=23).
(http://store.evtv.me/proddetail.php?prod=ArduinoDueCANBUS&cat=23)
The CANDue board must be running the GVRET firmware which can also be found The CANDue board must be running the GVRET firmware which can also be found
within the collin80 repos. within the collin80 repos.
@@ -23,27 +22,19 @@ It should, however, be noted that use of a capture device is not required to mak
of this program. It can load and save in several formats: of this program. It can load and save in several formats:
1. BusMaster log file 1. BusMaster log file
2. Microchip log file 2. Microchip log file
3. CRTD format (OVMS log file format from Mark Webb-Johnson) 3. CRTD format (OVMS log file format from Mark Webb-Johnson)
4. GVRET native format 4. GVRET native format
5. Generic CSV file (ID,D0 D1 D2 D3 D4 D5 D6 D7) 5. Generic CSV file (ID,D0 D1 D2 D3 D4 D5 D6 D7)
6. Vector Trace files 6. Vector Trace files
7. IXXAT Minilog files 7. IXXAT Minilog files
8. CAN-DO Logs 8. CAN-DO Logs
9. Vehicle Spy log files 9. Vehicle Spy log files
10. CANDump / Kayak (Read only) 10. CANDump / Kayak (Read only)
11. PCAN Viewer (Read Only) 11. PCAN Viewer (Read Only)
## Dependencies
Requires QScintilla library available at: Requires QScintilla library available at:
https://www.riverbankcomputing.com/software/qscintilla/download https://www.riverbankcomputing.com/software/qscintilla/download
@@ -57,23 +48,26 @@ However, this source code is integrated into the source for SavvyCAN and one isn
This project requires 5.6.0 or higher because of a dependency on QSerialBus which is an optional download This project requires 5.6.0 or higher because of a dependency on QSerialBus which is an optional download
with QT 5.6 (so, be sure to select it) with QT 5.6 (so, be sure to select it)
##Instructions for compiling: ## Instructions for compiling:
Download the newest stable version of Qt directly from qt.io (You need 5.6.x or newer) Download the newest stable version of Qt directly from qt.io (You need 5.6.x or newer)
download and extract QScintilla (see above for link), assume it is extracted in QScintilla-gpl-2.9.1 download and extract QScintilla (see above for link), assume it is extracted in QScintilla-gpl-2.9.1
```
cd ~/QScintilla-gpl-2.9.1/Qt4Qt5 cd ~/QScintilla-gpl-2.9.1/Qt4Qt5
```
You will need to either put your copy of QT into your path or specify the path to qmake directly You will need to either put your copy of QT into your path or specify the path to qmake directly
```
~/Qt/5.7/gcc_64/bin/qmake qscintilla.pro ~/Qt/5.7/gcc_64/bin/qmake qscintilla.pro
make make
sudo make install sudo make install
Optionally remove ~/QScintilla-gpl-2.9.1 # Optionally remove ~/QScintilla-gpl-2.9.1
cd ~ cd ~
@@ -84,20 +78,25 @@ cd SavvyCAN
~/Qt/5.7/gcc_64/bin/qmake ~/Qt/5.7/gcc_64/bin/qmake
make make
```
Now run SavvyCAN Now run SavvyCAN
```
./SavvyCAN ./SavvyCAN
```
##What to do if your compile failed? ## What to do if your compile failed?
The very first thing to do is try: The very first thing to do is try:
```
qmake qmake
make clean make clean
make make
```
Did that fix it? Great! If not, see if QT seems to be complaining about not finding the QScintilla header files. If that's the case then you are probably not using the same QT version as QScintilla was compiled against. It's easy to run the wrong qmake and have this happen. Double check that you've already compiled and installed QScintilla and that you've used the proper qmake version. Did that fix it? Great! If not, see if QT seems to be complaining about not finding the QScintilla header files. If that's the case then you are probably not using the same QT version as QScintilla was compiled against. It's easy to run the wrong qmake and have this happen. Double check that you've already compiled and installed QScintilla and that you've used the proper qmake version.