Skip to content
This repository was archived by the owner on Aug 30, 2023. It is now read-only.

Commit c4f527c

Browse files
authored
Add useful details to README
summary + install and usage instructions
1 parent 97d39b7 commit c4f527c

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
11
CWL generator for ACD (EMBOSS) files.
2+
=====================================
3+
4+
acd2cwl provides:
5+
- a2c-tools, a generator of wrappers for EMBOSS tools. It uses the formal definition of the tools provided by the ACD files.
6+
- a2c-tests, a generator of functional tests for these tools. It uses the functional tests defined in the EMBOSS package itself
7+
8+
Install
9+
-------
10+
11+
Installing the official package from PyPi:
12+
13+
`pip install acd2cwl`
14+
15+
Or from source:
16+
`
17+
git clone https://github.com/hmenager/acd2cwl.git
18+
cd acd2cwl && python setup.py install
19+
`
20+
21+
Run tool wrappers generator
22+
---------------------------
23+
24+
Simple command:
25+
26+
`a2c-tools /usr/share/EMBOSS/acd/*.acd`
27+
28+
For more options, just type
29+
30+
`a2c-tools --help`
31+
32+
Run test jobs generator
33+
-----------------------
34+
35+
Simple command:
36+
37+
`a2c-tests /usr/share/EMBOSS/test/qatest.dat /usr/share/EMBOSS/acd/*.acd`
38+
39+
For more options, just type
40+
41+
`a2c-tests --help`

0 commit comments

Comments
 (0)