Skip to content

Feature/nlynchjo/readme enhancements and file org changes #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Pull Request Checklist

Please review the [Contribution Guidelines](../README.md#contributing) before submitting.
Please review the [Contribution Guidelines](../README.md) before submitting.

- [ ] Pulling against the `develop` branch (left side).
- [ ] You have previously submitted a [Contributor License Agreement](../README.md#CLA) or have contacted a maintainer to request one.
- [ ] You have previously submitted a [Contributor License Agreement](../README.md) or have contacted a maintainer to request one.

### Type (Select only one)

Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/md-linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: md link-check
on:
pull_request:
branches:
- master
- develop
jobs:

build:
name: Build
runs-on: ubuntu-latest
steps:

- name: Set up Go 1.13
uses: actions/setup-go@v1
with:
go-version: 1.13
id: go

- name: Check out HEAD commit of a PR into the Go module directory
uses: actions/checkout@v2-beta
with:
ref: ${{ github.event.after }}

- name: md linkcheck
env:
GOPATH: ${{ runner.workspace }}
GO111MODULE: on
run: |
go get -u github.com/raviqqe/liche
$GOPATH/bin/liche -v -t 60 -x forum -r ${{ runner.workspace }}/Programmatic-Control-Examples
20 changes: 0 additions & 20 deletions .travis.yml

This file was deleted.

17 changes: 0 additions & 17 deletions Bit_Error_Rate_Testers/README.md

This file was deleted.

14 changes: 0 additions & 14 deletions DMMs/README.md

This file was deleted.

3 changes: 2 additions & 1 deletion Accessories/README.md → Examples/Accessories/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ Instrument Accessories, Cables and Connectors, Test Fixtures, PSPL Components &
* **[no content.. yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
23 changes: 23 additions & 0 deletions Examples/Bit_Error_Rate_Testers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Bit Error Rate Testers
BERTScope BA, BSA, BSX Series Bit Error Rate Testers, CR Series Clock Recovery Units, DPP Digital Pre-emphasis Processing & Linear Equalizers, PPG Series Multi-channel Pattern Generator, PED Series Error Detectors

## Directory
### LE320
| Example | Language |
| ------------------------------------------------------- | ------------------------------------------------------------ |
| **[Two Unit Control Example](./src/TwoUnitCtlExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |

### PPG

| Example | Language |
| ------------------------------------------------------ | ------------------------------------------------------------ |
| **[Simple Communications Example](./src/PPGExamples)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[User Pattern Example](./src/PPGExamples)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[User Pattern Long Example](./src/PPGExamples)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |



----
* **[Back to Home Page](./../../README.md)**

----
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Directory
* **[no content ... yet!](./)**


----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
16 changes: 16 additions & 0 deletions Examples/DMMs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Digital Multi Meters (DMM)
DMM6500, DMM7510, Series 2000 and 2100, Other DMM's

## Directory
### DMM4020
| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Maximum Reading Rate Example](./src/MaxReadRateExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |



----
* **[Back to Home Page](./../../README.md)**

----

Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ TLA 6400, TLA7000 Series Logic Analyzers
* **[no content.. yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Nanovoltmeters (2182 Series), Electrometers (6514, 6517), Curent Amplifiers (428
## Directory
* **[no content... yet!](./)**


----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----

31 changes: 31 additions & 0 deletions Examples/Oscilloscopes/BenchScopes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Bench Oscilloscopes
TBS1000, TDS2000B/C, TDS3000B/C, DPO/MSO2000/3000/4000 series scopes.



## Directory
### TDS2000/3000B/C, DPO/MSO2000/3000/4000 scope examples
| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Save on Trigger Example](./src/SaveonTrigExample)** | [![Python 2.7](https://img.shields.io/badge/python-2.7-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-2715/) |
| **[e*Scope Socket Get Screen Example](./src/eScopeGetScreenExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |



### TBS1000/B-EDU, TDS1000/2000/B/C, TPS2000/B scope examples

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Save Hardcopy to PC Example](./src/SaveHardcopyExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Simple Plot Example](./src/SimplePlotExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Convert IVI to MATLAB Driver Example](./src/Ivi2MatlabDriverExample)** | [![MATLAB](https://img.shields.io/badge/-MATLAB-&?labelColor=3E434A&colorB=F05A22&logo=Mathworks)](https://www.mathworks.com/products/matlab.html?s_tid=hp_products_matlab) |



### DPO/MSO2000/B scope examples

| Example | Language |
| ------------------------------------------------------ | ------------------------------------------------------------ |
| **[Search and Mark Example](./src/SearchMarkExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Get Waveform Example](./src/GetWaveformExample)** | [![MATLAB](https://img.shields.io/badge/-MATLAB-&?labelColor=3E434A&colorB=F05A22&logo=Mathworks)](https://www.mathworks.com/products/matlab.html?s_tid=hp_products_matlab) |

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
while True:
try:
SoTmain.main()
except:
except Exception as ex:
print "An unexpected error occured"
print "\n\nWould you like to start another capture" \
+ " session? (Y/N)"
Expand Down
21 changes: 21 additions & 0 deletions Examples/Oscilloscopes/MidrangeScopes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Midrange Oscilloscopes
DPO/MSO3000/4000B, MDO3000/4000/B/C series scopes

## Directory
### DPO/MSO3000/4000B & MDO3000/4000/B/C series scopes

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[MATLAB Plot Points Example](./src/MATLABPlotPointsExample)** | [![MATLAB](https://img.shields.io/badge/-MATLAB-&?labelColor=3E434A&colorB=F05A22&logo=Mathworks)](https://www.mathworks.com/products/matlab.html?s_tid=hp_products_matlab) |
| **[e*Scope Socket Get Screen Example](./../BenchScopes/src/eScopeGetScreenExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Simple Plot Example](./src/SimplePlotExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Save Hardcopy to PC Example](./src/SaveHardcopyExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |



### MDO3000/4000C series scopes

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[MDO3AFG, MDO4AFG Send Arb Example](./src/SendArbExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |

28 changes: 28 additions & 0 deletions Examples/Oscilloscopes/PerformanceScopes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Performance Oscillocopes
MSO/DPO5000/B, DPO7000/C, DSA70000/B/C/D, and MSO700000/C/DX

## Directory
#### MSO/DPO5000/B, DPO7000/C, DSA70000/B/C/D, and MSO70000/C/DX, DPO70000/B/C/D/DX/SX Series Digital Oscilloscope Examples

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Save Hardcopy to PC Example](./src/SaveHardCopyExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Simple Plot Example](./../MidrangeScopes/src/SimplePlotExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Extract Trigger Timestamp Example](./src/ExtractTriggerExample)** | [![C Sharp](https://img.shields.io/badge/-C%20Sharp-&?labelColor=3E434A&colorB=73BF44&logo=Microsoft)](https://github.com/dotnet/roslyn) |
| **[Curve Streaming Example](./src/CurvestreamExample)** | [![C Sharp](https://img.shields.io/badge/-C%20Sharp-&?labelColor=3E434A&colorB=73BF44&logo=Microsoft)](https://github.com/dotnet/roslyn) |



#### MSO5000B Examples
| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[FastFrame Save Individual Frame Example](./src/FastFrameSaveIndivFrameExample)** | [![Python 2.7](https://img.shields.io/badge/python-2.7-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-2715/) |



#### MSO/DPO7000/B/C, MSO/DPO70k (also DPOJet, TDSHT3) Example

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[TDSHT3 Module Control Example](./src/TDSHT3ModuleControlExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Tektronix Oscilloscopes
* **[Performance Real-Time Oscilloscopes](./PerformanceScopes)**
* **[Touchscreen Oscilloscopes & High Speed Digitizers](./TekSeriesScopes_HighSpeedDigitizers)**
----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**
----

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Tektronix Series Touch Screen Oscilloscopes and High Speed Digitizers
MDO3, MSO4/5/6 Series Oscilloscopes & MSO5LP/6LP High Speed Digitizers

## Directory
### MDO3 & MSO4/5/6/LP Examples

| Example | Language |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Save Hardcopy to PC Example](./../MidrangeScopes/src/SaveHardcopyExample)** | [![Python 2.7](https://img.shields.io/badge/python-2.7-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-2715/) |
| **[Simple Plot Example](./../MidrangeScopes/src/SimplePlotExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Read WFM File Example](./src/ReadWfmExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[MDO3AFG, MSO4/5/6AFG Send Arb Example](./../MidrangeScopes/src/SendArbExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |
| **[Extract Trigger Timestamp Example](./../PerformanceScopes/src/ExtractTriggerExample)** | [![C Sharp](https://img.shields.io/badge/-C%20Sharp-&?labelColor=3E434A&colorB=73BF44&logo=Microsoft)](https://github.com/dotnet/roslyn) |
| **[Pi Performance Testing Example](./src/PiPerformanceExample)** | [![Python 3.6](https://img.shields.io/badge/python-3.6-&?labelColor=3E434A&colorB=006281&logo=python)](https://www.python.org/downloads/release/python-360/) |

Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ Frequency Counters, Electronic Loads, Signal Pulse Generators, Keithley KUSB/KPC
* **[no content... yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ PA1000, PA3000, PA4000
* **[no content... yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
16 changes: 16 additions & 0 deletions Examples/Power_Supplies/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Power Supplies
Series 2200, Series 2260, Series 2280, Series 2300, Other Power Supplies

## Directory
### PWS4000 examples
| | |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| **[Source Voltage and Measure Example](./src/SourceVoltageExample)** | [![CPlusPlus](https://img.shields.io/badge/C-C++-&?labelColor=3E434A&colorB=006281&logo=cplusplus)](https://isocpp.org/) |



----
* **[Back to Home Page](./../../README.md)**

----

3 changes: 2 additions & 1 deletion Probes/README.md → Examples/Probes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ Tektronix Probes & Probe Accessories
* **[no content... yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
3 changes: 2 additions & 1 deletion SMUs/README.md → Examples/SMUs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@
* **[no content ... yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ S530 Parametric Test Systems, 4200-SCS Semiconductor Parameter Analyzer, ACS Sof
* **[no content... yet!](./)**

----
* **[Back to Home Page](./../README.md)**
* **[Back to Home Page](./../../README.md)**

----
Loading