Skip to content

Commit

Permalink
Add background section to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Donaim committed Mar 13, 2024
1 parent 5c387a6 commit 16429fa
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@

CFEIntact is an automated proviral intactness checker for HIV-1 consensus sequences, developed in Python. It enables researchers and clinicians to analyze HIV-1 sequences for intactness, aiding in the understanding of viral replication and persistence.

* **Automated Analysis:** Simplifies the process of checking HIV-1 consensus sequences for intactness with automated tools.
* **Extensible:** Designed to be extendable with additional checks and features as the field of HIV research evolves.
* **Open Source:** Encourages contributions and improvements from the community to make the tool more accurate and robust.
- **Automated Analysis:** Simplifies the process of checking HIV-1 consensus sequences for intactness with automated tools.
- **Extensible:** Designed to be extendable with additional checks and features as the field of HIV research evolves.
- **Open Source:** Encourages contributions and improvements from the community to make the tool more accurate and robust.

## Installation

Expand Down Expand Up @@ -46,6 +46,14 @@ proviral intact --subtype B sequences.fasta

Refer to the project's [website](https://cfe-lab.github.io/CFEIntact) for comprehensive documentation, including setup, usage examples, and development guidelines.

## Project Background

CFEIntact originated as a fork of [HIVIntact](https://github.com/ramics/HIVIntact), initially developed by Imogen Wright et al. This project owes its foundational concept to the original work and appreciates the efforts put in by the original team in advancing the field of HIV research.

However, over time, CFEIntact has undergone significant modifications and enhancements to better meet our evolving needs. These changes have led the project to diverge in ways that the original HIVIntact paper no longer accurately describes the forked version. CFEIntact has introduced new features, optimizations, and methodologies that are distinct from its origin, catering to a broader spectrum of analyses.

We encourage users and contributors to view CFEIntact as an extension and evolution of the ideas first introduced in HIVIntact, adjusted and expanded upon to serve contemporary research purposes.

## Contributing

We welcome contributions to CFEIntact! Whether you're fixing a bug, adding a new feature, or improving the documentation, your help makes CFEIntact better for everyone.
Expand Down

0 comments on commit 16429fa

Please sign in to comment.