Documentation and support for editing .c3d files.

.gitignore

@@ -2,6 +2,7 @@
 
 # C extensions
 *.so
+*.c3d
 
 # Packages
 *.egg
@@ -41,4 +42,4 @@ docs/_build
 .vscode/
 
 # mypy
-.mypy_cache/
+.mypy_cache/

README.rst

@@ -8,7 +8,7 @@ data recorded by a 3D motion tracking apparatus.
 Installing
 ----------
 
-Install with pip::
+Install with pip (currently outdated, download package from github instead)::
 
     pip install c3d
 
@@ -22,53 +22,52 @@ repository and build and install using the normal Python setup process::
 Usage
 -----
 
+Documentation and examples are available in the `package documentation`_.
+
 Tools
 ~~~~~
 
-This package includes a script for converting C3D motion data to CSV format
+This package includes scripts_ for converting C3D motion data to CSV format
 (``c3d2csv``) and an OpenGL-based visualization tool for observing the motion
 described by a C3D file (``c3d-viewer``).
 
+.. _scripts: ./scripts
+
 Library
 ~~~~~~~
 
-To use the C3D library, just import the package and create a ``Reader`` or
+To use the C3D library, just import the package and create a ``Reader`` and/or
 ``Writer`` depending on your intended usage
 
 .. code-block:: python
 
     import c3d
 
-    with open('data.c3d', 'rb') as handle:
-        reader = c3d.Reader(handle)
-        for i, (points, analog) in enumerate(reader.read_frames()):
-            print('Frame {}: {}'.format(i, points.round(2)))
-
-You can also get and set metadata fields using the library; see the `package
-documentation`_ for more details.
-
-.. _package documentation: http://c3d.readthedocs.org
+    with open('my-motion.c3d', 'rb') as file:
+        reader = c3d.Reader(file)
+        for i, points, analog in reader.read_frames():
+            print('frame {}: point {}, analog {}'.format(
+                  i, points.shape, analog.shape))
 
-Tests
-~~~~~
-
-To run tests available in the test folder, following command can be run from the root of the package directory::
-
-    python -m unittest discover .
+The library also provide functionality for editing both frame and metadata fields; 
+see the `package documentation`_ for more details.
 
+.. _package documentation: https://mattiasfredriksson.github.io/py-c3d/c3d/
 
 Caveats
 -------
 
-This library is minimally effective, in the sense that the only motion tracking
-system I have access to (for testing) is a Phasespace system. If you try out the
-library and find that it doesn't work with your motion tracking system, let me
-know. Pull requests are also welcome!
+The package is tested against the available `software examples`_ but may still not support
+every possible format. For example, parameters serialized in multiple parameters
+are not handled automatically (such as a LABELS field stored in both POINT:LABELS and
+POINT:LABELS2). Reading and writing files from a big-endian system is also not supported.
+
+Tests are currently only run on Windows, which means that Linux and Mac users may
+experience some issues. If you experience issues with a file or feature, feel free
+to post an issue (preferably by including example file/code/python exception)
+or make a pull request!
 
-Also, if you're looking for more functionality than just reading and writing C3D
-files, there are a lot of better toolkits out there that support a lot more file
-formats and provide more functionality, perhaps at the cost of increased
-complexity. The `biomechanical toolkit`_ is a good package for analyzing motion
-data.
+The package is Python only, support for other languages is available in other packages, for example see `ezc3d`_.
 
-.. _biomechanical toolkit: http://code.google.com/p/b-tk/
+.. _software examples: https://www.c3d.org/sampledata.html
+.. _ezc3d: https://github.com/pyomeca/ezc3d