Skip to content
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.

Sign up for GitHub

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

Updating readme file #3

Merged
merged 1 commit into from
May 6, 2024
Merged

Updating readme file #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Generate JSON and Save as Artifacts
name: Parser WebHelp and output npm package contains lua definitions file

on:
pull_request:
Expand Down Expand Up @@ -185,7 +185,7 @@ jobs:
uses: ncipollo/release-action@v1
with:
name: ${{steps.lasttag.outputs.version}}
artifacts: "extension/*.vsix,sbom/**/*"
artifacts: "keithley_instrument_libraries,generated-json"
body: |
## Features Requests / Bugs

Expand Down
34 changes: 0 additions & 34 deletions .github/workflows/release.yml
View file
Open in desktop

This file was deleted.

39 changes: 0 additions & 39 deletions .github/workflows/release_candidate.yml
View file
Open in desktop

This file was deleted.

11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# tsp-toolkit-webhelp-to-json
The parser to convert from the WebHelp version of the instrument command-set references to the internal JSON format.
This repository contains tools for converting Keithley instruments WebHelp documents into Lua definitions files. The conversion process occurs in two steps:

## 1. WebHelp to Internal JSON:
In this initial step, the tool takes a Keithley instruments WebHelp documents and converts it into an internal JSON format.

## 2. Internal JSON to Lua Definitions:
Once the WebHelp document is converted into internal JSON, the tool proceeds to generate Lua definitions files. These Lua files are packaged into an npm package.

# Quick Start
- Clone the repo
- Go to **Configuration.py** file and update the configurations
- Open **main.py** file and start run
Loading