Skip to content

Commit

Permalink
mention similar packages in documentation (ni#153)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhindes authored Feb 15, 2022
1 parent a8b9d05 commit 3c8137e
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file.
* ...
* ### Resolved Issues
* [37: ai_raw example is bad](https://github.com/ni/nidaqmx-python/issues/37)
* [64: nidaqmx-python and pynidaqmx projects use the same package name](https://github.com/ni/nidaqmx-python/issues/64)
* [65: ci_count_edges.py REQUIRES A START COMMAND](https://github.com/ni/nidaqmx-python/issues/65)
* [100: How to clear task and create a new task with same name?](https://github.com/ni/nidaqmx-python/issues/100)
* [102: handle types and daqmx versions](https://github.com/ni/nidaqmx-python/issues/102)
Expand Down
18 changes: 16 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,27 @@ Installation
============

Running **nidaqmx** requires NI-DAQmx or NI-DAQmx Runtime. Visit the
`ni.com/downloads <http://www.ni.com/downloads/>`_ to download the latest version
of NI-DAQmx.
`ni.com/downloads <http://www.ni.com/downloads/>`_ to download the latest
version of NI-DAQmx.

**nidaqmx** can be installed with `pip <http://pypi.python.org/pypi/pip>`_::

$ python -m pip install nidaqmx

Similar Packages
================

There are similar packages available that also provide NI-DAQmx functionality in
Python:

- `daqmx <https://pypi.org/project/daqmx/>`_
(`slightlynybbled/daqmx on GitHub <https://github.com/slightlynybbled/daqmx>`_)
provides an abstraction of NI-DAQmx in the ``ni`` module.

- PyLibNIDAQmx (`pearu/pylibnidaqmx on GitHub <https://github.com/pearu/pylibnidaqmx>`_)
provides an abstraction of NI-DAQmx in the ``nidaqmx`` module, which collides
with this package's module name.

.. _usage-section:

Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []


# -- Options for HTMLHelp output ------------------------------------------
Expand Down

0 comments on commit 3c8137e

Please sign in to comment.