diff --git a/README.md b/README.md index 7b18c6ad1524afc883c1c404bd206ef9be1abbee..d9eaeb76a52300f02eba3e3ef8828cc4e05172f3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # BioInformatics Tool for Infrastructure Automation (BiTIA) CLI utility This is the cli utility of the BiTIA project. The other component is @@ -31,3 +33,26 @@ TODO: Order of searching configuration file. If you are self-hosting the BiTIA server, you need `bitia-runner` as well. See the documents of `bitia-runner` for more details. TODO. + + +## EXAMPLES + +1. Using samtools to view a fastq file + +<div style="display: grid;grid-template-columns: 1fr 1fr;grid-gap: 20px;flex-direction:row;"> + + +<div style="padding-left: 40px;"> + +<h3>NORMAL PIPELINE EXECUTION CODE</h3> +<img src="./docs/source/img/readme_example_1.gif" /> +</div> + + +<div > + +<h3>BITIA EXECUTION CODE</h3> +<img src="./docs/source/img/readme_example_1_bitia.gif" /> + +</div> +</div> \ No newline at end of file diff --git a/docs/source/img/readme_example_1.gif b/docs/source/img/readme_example_1.gif new file mode 100644 index 0000000000000000000000000000000000000000..f2f5afbcabc6b29aacf645c97f579bd6b24d7038 Binary files /dev/null and b/docs/source/img/readme_example_1.gif differ diff --git a/docs/source/img/readme_example_1_bitia.gif b/docs/source/img/readme_example_1_bitia.gif new file mode 100644 index 0000000000000000000000000000000000000000..bcc614f86295fbff80688b76c91ea2239003744e Binary files /dev/null and b/docs/source/img/readme_example_1_bitia.gif differ