diff --git a/README.md b/README.md index 53af14c..575f1e0 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,22 @@ Simple terminal sequence alignment viewer. +![Screenshot](/screenshots/prot.png?raw=true "Screenshot") + ### What is Alen? It's a command-like program to view DNA or protein alignments in FASTA formats. While more functionality will probably be added, Alen is intended to do the bare minimum of allowing you to view your alignments. It's meant for having a quick view of an alignment without having to leave the shell. It's not an alignment editor. It's not much, honestly. ### How to install and run. Alen _should_ work on most Unix systems, and Windows 10. If someone asks me to, I might add Windows 7 and 8 support. -You can get it by downloading it from here and compiling it using Cargo. +You can get it by downloading it from here and compiling it using Cargo. If other people begin using this tool, I might upload precompiled binaries. + +### How to use +Simple usage: +``` +$ alen /path/to/alignment.fasta +``` + +Note that Alen loads in the entire alignment in memory, so don't use it for multi-gigabyte files. Alen will auto-detect whether the alignment is protein or amino acid alignments. For more help, type `alen --help` in the terminal. ### Why the name? First, it's to pun on the unimaginative named [alan](https://github.com/mpdunne/alan) and [alv](https://github.com/arvestad/alv). Second, _alen_ means _cubit_ in Danish. Like using cubits, Alen is simple, crude, but usually _good enough_. \ No newline at end of file diff --git a/screenshots/prot.png b/screenshots/prot.png new file mode 100644 index 0000000..5161e7e Binary files /dev/null and b/screenshots/prot.png differ diff --git a/src/main.rs b/src/main.rs index 833e1a7..63d1ce0 100644 --- a/src/main.rs +++ b/src/main.rs @@ -495,10 +495,10 @@ fn draw_sequences(io: &mut T, view: &View) { } fn main() { - let args = clap::App::new("alen") + let args = clap::App::new("Alen") .version("0.1") .author("Jakob Nybo Nissen ") - .about("Simple alignment viewer") + .about("Simple terminal alignment viewer") .arg(clap::Arg::with_name("alignment") .help("Input alignment in FASTA format (- for stdin)") .takes_value(true)