Updated/new documentation for custom nodes, CLI, tests - Githubissues

PyWorkflowApp / visual-programming

A Python Visual Programming Workspace for Data Science

MIT License

31 stars 12 forks source link

Updated/new documentation for custom nodes, CLI, tests #83

Closed reelmatt closed 4 years ago

reelmatt commented 4 years ago

Updated the main README to include:

A table of badges for existing/TBD tests
Changed wording to reflect what PyWorkflow aims to do, heavily influenced by the Milestone 2 report.
Updated code styles to code-blocks instead of inline code snippets.
Reflects some TBD features like Docker functionality and still in-progress CLI features.

Adds new doc files for:

CLI: purpose, syntax, and using stdin/stdout
Test: moved most of the details from the main README to a separate file. To be expanded later.
Custom nodes: how to write a custom node with examples and greater detail than previously existed.

Labeling this as a work in progress since some of this reflects some functionality that's not yet finished and may be subject to change.

reddigari commented 4 years ago

Really great documentation!