diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | doc/ccwl.texi | 53 |
2 files changed, 55 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am index cabf6cc..f0b0bcb 100644 --- a/Makefile.am +++ b/Makefile.am @@ -39,6 +39,8 @@ SUFFIXES = .scm .go moddir = $(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION) godir = $(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache +info_TEXINFOS = doc/ccwl.texi + SOURCES = \ ccwl/ccwl.scm \ ccwl/yaml.scm \ diff --git a/doc/ccwl.texi b/doc/ccwl.texi new file mode 100644 index 0000000..60d1731 --- /dev/null +++ b/doc/ccwl.texi @@ -0,0 +1,53 @@ +\input texinfo +@settitle Concise Common Workflow Language + +@copying +Copyright @copyright{} 2021 Arun Isaac@* + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A +copy of the license is included in the section entitled ``GNU Free +Documentation License''. +@end copying + +@ifnottex +@node Top +@top Concise Common Workflow Language +@end ifnottex + +This manual documents the development version of @abbr{ccwl, Concise +Common Workflow Language}, a concise syntax to express @abbr{CWL, Common +Workflow Language} workflows. + +@menu +* Introduction:: What is ccwl? +* Contributing:: Contributing +@end menu + +@node Introduction +@chapter Introduction + +@abbr{CWL, Common Workflow Language} is an open standard for describing +analysis workflows and tools in a way that makes them portable and +scalable across a variety of software and hardware environments. + +@abbr{ccwl, Concise Common Workflow Language} is a concise syntax to +express CWL workflows. It is implemented as an @abbr{EDSL, Embedded +Domain Specific Language} in the Scheme programming language, a +minimalist dialect of the Lisp family of programming languages. + +ccwl is a compiler to generate CWL workflows from concise descriptions +in ccwl. In the future, ccwl will also have a runtime whereby users can +interactively execute workflows while developing them. + +@node Contributing +@chapter Contributing + +ccwl is developed on GitHub at +@url{https://github.com/arunisaac/ccwl}. Feedback, suggestions, feature +requests, bug reports and pull requests are all welcome. Unclear and +unspecific error messages are considered a bug. Do report them! + +@bye |