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.

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

README improvements for upcoming public announcements #622

Merged
merged 3 commits into from
Aug 8, 2024

Conversation

zhindes
Copy link
Collaborator

@zhindes zhindes commented Aug 6, 2024

What does this Pull Request accomplish?

Improves the README in a few ways.

  • Added a table of contents
  • Put a link to readthedocs front and center for people who get to the GitHub first (we already have a link to GitHub front and center from readthedocs!)
  • Added nidaqmx installdriver to the installation section
  • Added a section for Examples
  • Minor improvements to readability of the raw rst file

Why should this Pull Request be merged?

New product announcement coming soon is going to highlight our Python API quite a bit.

What testing has been done?

Visual inspection and review of the docs output.

image

@zhindes zhindes requested a review from WayneDroid August 6, 2024 21:33
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Aug 6, 2024

Test Results

    34 files  ±0      34 suites  ±0   52m 29s ⏱️ +40s
 2 348 tests ±0   1 994 ✅ ±0    354 💤 ±0  0 ❌ ±0 
42 272 runs  ±0  36 020 ✅ ±0  6 252 💤 ±0  0 ❌ ±0 

Results for commit b0eba6e. ± Comparison against base commit 56feb61.

@zhindes zhindes requested a review from bkeryan August 7, 2024 19:40
Copy link
Collaborator

@bkeryan bkeryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with suggestions (spelling)

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@zhindes zhindes enabled auto-merge (squash) August 8, 2024 18:45
@zhindes zhindes merged commit 53db026 into master Aug 8, 2024
13 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants