-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some improvements inspired by #1250.
Showing
1 changed file
with
17 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,47 @@ | ||
# khmer | ||
|
||
[![Research software impact](http://depsy.org/api/package/pypi/khmer/badge.svg)](http://depsy.org/package/python/khmer) | ||
[![khmer build status](https://img.shields.io/travis/dib-lab/khmer.svg)](https://travis-ci.org/dib-lab/khmer) | ||
[![Test coverage](https://img.shields.io/codecov/c/github/dib-lab/khmer.svg)](https://codecov.io/github/dib-lab/khmer) | ||
[![BSD-3 licensed](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](https://github.com/dib-lab/khmer/blob/master/LICENSE) | ||
|
||
|
||
# khmer | ||
|
||
Welcome to khmer: k-mer counting, filtering and graph traversal FTW! | ||
|
||
The official source code repository is at https://github.com/dib-lab/khmer | ||
and you can read the docs online at http://khmer.readthedocs.io. | ||
|
||
There are two mailing lists dedicated to khmer, an announcements-only | ||
list and a discussion list. To search their archives and sign-up for | ||
them, please visit the following URLs: | ||
|
||
- Discussion: http://lists.idyll.org/listinfo/khmer | ||
- Announcements: http://lists.idyll.org/listinfo/khmer-announce | ||
## Getting help | ||
|
||
See http://khmer.readthedocs.io/en/stable/user/getting-help.html for more | ||
details, but in brief: | ||
|
||
The maintainers can be contacted at <[email protected]>. | ||
- first point of contact when looking for help: https://github.com/dib-lab/khmer/issues | ||
- mailing list for **discussion**: http://lists.idyll.org/listinfo/khmer | ||
- mailing list for **announcements**: http://lists.idyll.org/listinfo/khmer-announce | ||
- email contact for project maintainers: <[email protected]> | ||
|
||
For getting help please see this guide: http://khmer.readthedocs.io/en/stable/user/getting-help.html | ||
Your first port of call when looking for help should be: https://github.com/dib-lab/khmer/issues | ||
|
||
## Important note: cite us! | ||
|
||
khmer is *research software*, so you should cite us when you use it | ||
in scientific publications! Please see the [CITATION](http://khmer.readthedocs.io/en/stable/citations.html) | ||
file for citation information. | ||
|
||
The khmer library is a project of the [Lab for Data Intensive Biology](http://ivory.idyll.org/lab/) | ||
at UC Davis: its members, collaborators, and friends. | ||
|
||
|
||
## Quick install | ||
|
||
``` | ||
pip install khmer | ||
FIXME FIXME py.test command here FIXME FIXME | ||
``` | ||
|
||
See https://khmer.readthedocs.io/en/stable/user/install.html for more details. | ||
See https://khmer.readthedocs.io/en/stable/user/install.html for more detailed | ||
installation instructions. | ||
|
||
|
||
## Contributing | ||
|