Skip to content
This repository was archived by the owner on Jun 9, 2020. It is now read-only.

Commit 1ad4f7c

Browse files
committed
Fix README spelling (AU>US), add references sec and increase clarity
1 parent f2625d5 commit 1ad4f7c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,16 @@ You can install python-cwlgen through pip with the following command:
3636
pip install cwlgen
3737
```
3838

39-
### How it works ?
39+
### How it works?
4040

41-
There's a copy of the cwl specifications ([Workflow](https://www.commonwl.org/v1.0/Workflow.html)|
42-
[CommandLineTool](https://www.commonwl.org/v1.0/CommandLineTool.html)), where the Python classes mirror the CWL spec.
43-
This repository also includes docstrings to give you context of classes and their properties.
41+
This repository contains a number of python classes that mirror the CWL specifications ([Workflow](https://www.commonwl.org/v1.0/Workflow.html)|
42+
[CommandLineTool](https://www.commonwl.org/v1.0/CommandLineTool.html)). In essence, each class's initializer has all
43+
of the properties it expects, which may be another object. The classes include the relevant docstrings to give you
44+
context of classes and their properties.
45+
46+
The `examples/` folder contains some simple examples, however in essence you simply initialize the class you're
47+
trying to build. An initializer for a class has all of the properties it expects which may be another object.
4448

45-
The `examples/` folder contains some simple examples, however ,
46-
you can simply initialise that class, for example:
4749

4850
_Creating a CommandLineTool_
4951
```python
@@ -69,3 +71,9 @@ tool_object.export()
6971
with open("echotool.cwl", "w") as f:
7072
tool_object.export(f)
7173
```
74+
75+
## References
76+
77+
CWL is developed by an informal, multi-vendor working group consisting of organizations and individuals
78+
aiming to enable scientists to share data analysis workflows.
79+
The [CWL project is on Github](https://github.com/common-workflow-language/common-workflow-language).

0 commit comments

Comments
 (0)