Skip to content

Commit 9965f5d

Browse files
committed
Update usage sections, fix some formatting and typos
Signed-off-by: Joe Friedrichsen <[email protected]>
1 parent 098c4b2 commit 9965f5d

File tree

6 files changed

+33
-16
lines changed

6 files changed

+33
-16
lines changed

examples/all_types/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
## All Types Example
22

3-
This is an example for `nipanel` that demonstrates all supported data types
3+
This is an example for `nipanel` that demonstrates all supported data types.
44

55
### Feature
66

7-
- Demonstrates support for all data types
7+
- Demonstrates all supported data types
88

99
### Required Software
1010

1111
- Python 3.9 or later
1212

1313
### Usage
1414

15-
Run `poetry run python examples/all_types/all_types.py`
15+
```pwsh
16+
poetry install --with examples
17+
poetry run python examples/all_types/all_types.py
18+
```

examples/hello/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Hello
22

3-
This is a simple nipanel example that displays a Streamlit app.
3+
This is a simple `nipanel` example that displays a Streamlit app.
44

55
### Feature
66

@@ -12,4 +12,7 @@ This is a simple nipanel example that displays a Streamlit app.
1212

1313
### Usage
1414

15-
Run `poetry run python examples/hello/hello.py`
15+
```pwsh
16+
poetry install --with examples
17+
poetry run python examples/hello/hello.py
18+
```

examples/nidaqmx/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Prerequisites
1+
Prerequisites
22
===============
33
Requires a Physical or Simulated Device : https://github.com/ni/nidaqmx-python/blob/master/README.rst (Getting Started Section)
44

@@ -16,5 +16,7 @@ This is a nipanel example that displays an interactive Streamlit app and updates
1616

1717
### Usage
1818

19-
Run `poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py`
20-
19+
```pwsh
20+
poetry install --with examples
21+
poetry run examples/nidaqmx/nidaqmx_continuous_analog_input.py
22+
```

examples/niscope/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
Prerequisites
1+
Prerequisites
22
===============
33
Requires a Physical or Simulated Device. Refer to the [Getting Started Section](https://github.com/ni/nidaqmx-python/blob/master/README.rst) to learn how to create a simulated device. This example uses NI oscilloscopes/digitizers, which have the module numbering pattern _51xx_. One example is NI PXIe-5114.
4+
45
## Sample
56

67
This is a nipanel example that displays an interactive Streamlit app and updates and fetches data from device.
78

89
### Feature
910

10-
Script demonstrates NIScope waveform data getting continuously acquired.
11+
Script demonstrates NIScope waveform data getting continuously acquired.
1112
- Supports various data types
1213

1314
### Required Software
@@ -16,5 +17,7 @@ Script demonstrates NIScope waveform data getting continuously acquired.
1617

1718
### Usage
1819

19-
Run `poetry run examples/niscope/niscope_ex_fetch_forever.py`
20-
20+
```pwsh
21+
poetry install --with examples
22+
poetry run examples/niscope/niscope_ex_fetch_forever.py
23+
```

examples/performance_checker/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Performance checker Example
22

3-
This example measures the performance of a stremlit panel with a graph.
3+
This example measures the performance of a streamlit panel with a graph.
44

55
## Features
66

@@ -15,4 +15,7 @@ This example measures the performance of a stremlit panel with a graph.
1515

1616
### Usage
1717

18-
Run `poetry run python examples/performance_checker/performance_checker.py`
18+
```pwsh
19+
poetry install --with examples
20+
poetry run python examples/performance_checker/performance_checker.py
21+
```

examples/simple_graph/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Simple Graph Example
22

3-
This example demonstrates using nipanel with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.
3+
This example demonstrates using `nipanel` with Streamlit to display a dynamic sine wave using the `streamlit-echarts` library.
44

55
## Features
66

@@ -15,4 +15,7 @@ This example demonstrates using nipanel with Streamlit to display a dynamic sine
1515

1616
### Usage
1717

18-
Run `poetry run python examples/simple_graph/simple_graph.py`
18+
```pwsh
19+
poetry install --with examples
20+
poetry run python examples/simple_graph/simple_graph.py
21+
```

0 commit comments

Comments
 (0)