Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
William-Gardner-Biotech authored May 9, 2024
1 parent c928979 commit d006c9d
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,22 @@ Optional: Barcode region from SIVmac239M is removed using bedtools. This can be

This repository contains sample data and sample output files to demonstrate the pipeline's functionality. To run the pipeline on your own data, follow these steps:

1. Clone the repository: `git clone https://github.com/your-repo/EVTA.git`
2. Download requirements or use Docker image (still being built).
3. Place your paired-end sequencing files (FASTQs) in the `data/` directory.
4. Configure your paths and settings in nextflow.config
5. Run the main.nf program
1. Clone the repository
2. Configure the Docker image
3. Place your paired-end sequencing files (FASTQs) in the `data/` directory
4. Mount volumes to Docker container
5. Configure your paths and settings in nextflow.config
6. Run the main.nf program

The pipeline will process your data, and the output files will be generated in the configured results directory.

## Requirements
## Docker image:

- Docker (A Dockerfile will be provided in the future releases)
- Required software dependencies (to be listed)
```docker build -t evta .```

OR

```docker pull willgardnerbiotech/evta_1.0```

## Contributing

Expand Down

0 comments on commit d006c9d

Please sign in to comment.