From 83ab7ca26d98d698aa46b302f0210c1f26c56b96 Mon Sep 17 00:00:00 2001 From: Bano733-code Date: Fri, 28 Nov 2025 09:35:51 +0500 Subject: [PATCH 1/3] Fix typos, add usage example, clarify tests and contributing --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b1036848..2c0e71db 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,21 @@ biological sequences, including DNA, RNA, and amino acid sequences. You can install BioSequences from the julia REPL. Press `]` to enter pkg mode, and enter the following: -```julia +```julia add BioSequences ``` +## Example +```julia +using BioSequences + +# Create a DNA sequence +seq = DNASequence("ACGTACGT") +println(seq) + +# Get the reverse complement +revcomp = reverse_complement(seq) +println(revcomp) +``` If you are interested in the cutting edge of the development, please check out the master branch to try new features before release. @@ -31,14 +43,26 @@ BioSequences is tested against Julia `1.X` on Linux, OS X, and Windows. [![](https://codecov.io/gh/BioJulia/BioSequences.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/BioJulia/BioSequences.jl) [![Downstream](https://github.com/BioJulia/BioSequences.jl/actions/workflows/Downstream.yml/badge.svg)](https://github.com/BioJulia/BioSequences.jl/actions/workflows/Downstream.yml) +Run tests from the Julia REPL: +```julia +using Pkg +Pkg.test("BioSequences") +``` ## Contributing We appreciate contributions from users including reporting bugs, fixing issues, improving performance and adding new features. -Take a look at the [contributing files](https://github.com/BioJulia/Contributing) -detailed contributor and maintainer guidelines, and code of conduct. +Take a look at the [contributing files](https://github.com/BioJulia/Contributing) for detailed contributor and maintainer guidelines, and code of conduct. + +Steps to contribute: + +1. Fork the repository +2. Clone your fork locally +3. Make your changes +4. Commit & push to your fork +5. Open a Pull Request ## Backers & Sponsors From 845eeef2fd2044d49ebcac8fca01a7ec81a049c5 Mon Sep 17 00:00:00 2001 From: Bano733-code Date: Tue, 2 Dec 2025 06:37:28 +0500 Subject: [PATCH 2/3] Update README.md Co-authored-by: Kevin Bonham --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c0e71db..3420e1be 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ biological sequences, including DNA, RNA, and amino acid sequences. You can install BioSequences from the julia REPL. Press `]` to enter pkg mode, and enter the following: -```julia +```julia add BioSequences ``` ## Example From 62d9004bb2f96f826f783681a1b3c949b9e48ccd Mon Sep 17 00:00:00 2001 From: Bano733-code Date: Tue, 2 Dec 2025 06:42:28 +0500 Subject: [PATCH 3/3] Update README.md Co-authored-by: Kevin Bonham --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3420e1be..bdaf4ac4 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ add BioSequences using BioSequences # Create a DNA sequence -seq = DNASequence("ACGTACGT") +seq = DNASequence("ACGTACGT") # or dna"ACGTACGT" println(seq) # Get the reverse complement