From eccfd9641fcbc4d25f5740a97d940a4ac10722bb Mon Sep 17 00:00:00 2001 From: David Graeff Date: Fri, 22 Dec 2017 11:51:09 +0100 Subject: [PATCH] Fix docs for website generation --- docs/_config.yml | 9 ++++++++- docs/adddevice.md | 3 +++ docs/build.md | 4 +++- docs/images/openhantek.png | Bin 0 -> 1095 bytes docs/index.md | 8 ++++++-- docs/limitations.md | 4 +++- 6 files changed, 23 insertions(+), 5 deletions(-) create mode 100644 docs/images/openhantek.png diff --git a/docs/_config.yml b/docs/_config.yml index bb9f55d..bd2e388 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,8 +1,15 @@ title: Openhantek -description: +description: Software for Hantek and compatible (Voltcraft/Darkwire/Protek/Acetech) USB digital signal oscilloscopes google_analytics: show_downloads: true theme: jekyll-theme-slate gems: - jekyll-mentions + +exclude: + - .gitignore + - CNAME + - readme.md + +logo: /img/openhantek.png diff --git a/docs/adddevice.md b/docs/adddevice.md index 131c8f7..2849c6d 100644 --- a/docs/adddevice.md +++ b/docs/adddevice.md @@ -1,3 +1,6 @@ +--- +layout: default +--- # How to add a new device We only accept new devices whoms firmware is hantek protocol compatible. Codewise you will only need to touch files within `openhantek/src/hantek`. diff --git a/docs/build.md b/docs/build.md index 514b358..244db49 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,4 +1,6 @@ - +--- +layout: default +--- ### [Linux](#linux) For debian based systems (Ubuntu, Mint) install named requirements like this: > apt install g++ cmake qttools5-dev qttools5-dev-tools libfftw3-dev binutils-dev libusb-1.0-0-dev libqt5opengl5-dev diff --git a/docs/images/openhantek.png b/docs/images/openhantek.png new file mode 100644 index 0000000..f492e4d Binary files /dev/null and b/docs/images/openhantek.png differ diff --git a/docs/index.md b/docs/index.md index bde7df3..8be4cb8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +layout: default +overview: true +--- # 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) 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 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. - - + +
Image of main window on linux Image of main window on Windows Image of main window on linux Image of main window on Windows
* Supported operating systems: Linux, MacOSX, Windows¹ diff --git a/docs/limitations.md b/docs/limitations.md index c5bd775..22742cb 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -1,4 +1,6 @@ - +--- +layout: default +--- ## Software triggered devices like the 6022BE - 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) -- libgit2 0.21.4