Peter M. Groen / openhantek

Commit eccfd9641fcbc4d25f5740a97d940a4ac10722bb

Authored by David Graeff
Committed by David Gräff
1 parent 8d620a74

Fix docs for website generation

Inline Side-by-side
Showing 6 changed files with 23 additions and 5 deletions
docs/_config.yml
  View file @eccfd96
1 title: Openhantek 1 title: Openhantek
2 -description: 2 +description: Software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes
3 google_analytics: 3 google_analytics:
4 show_downloads: true 4 show_downloads: true
5 theme: jekyll-theme-slate 5 theme: jekyll-theme-slate
6 6
7 gems: 7 gems:
8 - jekyll-mentions 8 - jekyll-mentions
  9 +
  10 +exclude:
  11 + - .gitignore
  12 + - CNAME
  13 + - readme.md
  14 +
  15 +logo: /img/openhantek.png
docs/adddevice.md
  View file @eccfd96
  1 +---
  2 +layout: default
  3 +---
1 # How to add a new device 4 # How to add a new device
2 We only accept new devices whoms firmware is hantek protocol compatible. 5 We only accept new devices whoms firmware is hantek protocol compatible.
3 Codewise you will only need to touch files within `openhantek/src/hantek`. 6 Codewise you will only need to touch files within `openhantek/src/hantek`.
docs/build.md
  View file @eccfd96
1 - 1 +---
  2 +layout: default
  3 +---
2 ### [Linux](#linux) 4 ### [Linux](#linux)
3 For debian based systems (Ubuntu, Mint) install named requirements like this: 5 For debian based systems (Ubuntu, Mint) install named requirements like this:
4 > apt install g++ cmake qttools5-dev qttools5-dev-tools libfftw3-dev binutils-dev libusb-1.0-0-dev libqt5opengl5-dev 6 > apt install g++ cmake qttools5-dev qttools5-dev-tools libfftw3-dev binutils-dev libusb-1.0-0-dev libqt5opengl5-dev
docs/images/openhantek.png 0 → 100644
View file @eccfd96

1.07 KB
docs/index.md
  View file @eccfd96
  1 +---
  2 +layout: default
  3 +overview: true
  4 +---
1 # OpenHantek [![Build Status](https://travis-ci.org/OpenHantek/openhantek.svg?branch=master)](https://travis-ci.org/OpenHantek/openhantek) [![Build status](https://ci.appveyor.com/api/projects/status/9w4rd5r04ufqafr4/branch/master?svg=true)](https://ci.appveyor.com/project/davidgraeff/openhantek/branch/master) 5 # OpenHantek [![Build Status](https://travis-ci.org/OpenHantek/openhantek.svg?branch=master)](https://travis-ci.org/OpenHantek/openhantek) [![Build status](https://ci.appveyor.com/api/projects/status/9w4rd5r04ufqafr4/branch/master?svg=true)](https://ci.appveyor.com/project/davidgraeff/openhantek/branch/master)
2 6
3 OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes. 7 OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes.
@@ -5,8 +9,8 @@ OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Prot @@ -5,8 +9,8 @@ OpenHantek is a free software for Hantek and compatible (Voltcraft/Darkwire/Prot
5 It has started as an alternative to the official Hantek DSO software for Linux users. Nowadays it works under Microsoft Windows and Apple Mac OS as well. 9 It has started as an alternative to the official Hantek DSO software for Linux users. Nowadays it works under Microsoft Windows and Apple Mac OS as well.
6 10
7 <table><tr> 11 <table><tr>
8 - <td> <img alt="Image of main window on linux" width="100%" src="docs/images/screenshot_mainwindow.png"> </td>  
9 - <td> <img alt="Image of main window on Windows" width="100%" src="docs/images/screenshot_mainwindow_win.png"> </td> 12 + <td> <img alt="Image of main window on linux" width="100%" src="images/screenshot_mainwindow.png"> </td>
  13 + <td> <img alt="Image of main window on Windows" width="100%" src="images/screenshot_mainwindow_win.png"> </td>
10 </tr></table> 14 </tr></table>
11 15
12 * Supported operating systems: Linux, MacOSX, Windows¹ 16 * Supported operating systems: Linux, MacOSX, Windows¹
docs/limitations.md
  View file @eccfd96
1 - 1 +---
  2 +layout: default
  3 +---
2 ## Software triggered devices like the 6022BE 4 ## Software triggered devices like the 6022BE
3 5
4 - Support 48, 24, 16, 8, 4, 2, 1 M and 500, 200, 100 k Hz samplerates. For the 6022 with modded firmware by [jhoenicke](https://github.com/rpcope1/Hantek6022API) 6 - Support 48, 24, 16, 8, 4, 2, 1 M and 500, 200, 100 k Hz samplerates. For the 6022 with modded firmware by [jhoenicke](https://github.com/rpcope1/Hantek6022API)