Merge pull request #160 from evolarjun/master

Citation and README updates
ncbi · Jan 15, 2025 · a26045f · a26045f
2 parents 0e2291c + 76541af
commit a26045f
Show file tree

Hide file tree

Showing 3 changed files with 1 addition and 53 deletions.
diff --git a/CITATION.cff b/CITATION.cff
diff --git a/CITATION.md b/CITATION.md
@@ -0,0 +1 @@
+Please see our [wiki instructions on citing AMRFinderPlus](https://github.com/ncbi/amr/wiki#citation) for more information on how to cite AMRFinderPlus. Importantly we ask that you include both the software version and database version in your methods so people can reproduce your results.
diff --git a/README.md b/README.md
@@ -1,17 +1,3 @@
-# WARNING: This is an experimental version that includes StxTyper
-
-Currently it will need to be compiled from source to install.
-
-### Downloading and compiling AMRFinderPlus with StxTyper
-
-    git clone https://github.com/ncbi/amr.git
-    cd amr
-    git checkout stxtype
-    git submodule update --init
-    make
-    ./amrfinder -u
-    make test
-
 # NCBI Antimicrobial Resistance Gene Finder (AMRFinderPlus)
 
 This software and the accompanying database are designed to find acquired antimicrobial resistance genes and point mutations in protein and/or assembled nucleotide sequences. We have also added "plus" stress, heat, and biocide resistance and virulence factors for [some organisms](https://github.com/evolarjun/amr/wiki/Curated-organisms).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Please see our [wiki instructions on citing AMRFinderPlus](https://github.com/ncbi/amr/wiki#citation) for more information on how to cite AMRFinderPlus. Importantly we ask that you include both the software version and database version in your methods so people can reproduce your results.