cjcodeproj / medialibrary

Python code to read XML media files
MIT License
2 stars 0 forks source link

Create simple example documentation #125

Closed cjcodeproj closed 11 months ago

cjcodeproj commented 1 year ago

The tools need some simple usage documentation that covers the command line tools, and Python shell invocation.

The documentation should follow Python conventions, and they should probably be in RST format. I will also need to figure out Python conventions for bundling extra documentation with a package.

cjcodeproj commented 11 months ago

Additional notes:

Links:

cjcodeproj commented 11 months ago

One more addendum:

The documentation should be bundled with the code, but I'm not 100% concerned with the presentation. If the documentation files are readable on GitHub through the web interface, then I'm fine with that. Building usable documentation files suitable for installation on a host can be focused on a later date.

cjcodeproj commented 11 months ago

Commit:

https://github.com/cjcodeproj/medialibrary/commit/5fc1673596ba29af5fa9976294d4b455c334a88e

cjcodeproj commented 11 months ago

Closing Notes: