From f43eea4db04cb34ec4b322fa007407a71450027e Mon Sep 17 00:00:00 2001 From: Bob Harris Date: Tue, 30 Oct 2018 15:30:55 -0400 Subject: [PATCH] bumped to version 1.0.0 in prep for making public; added license --- LICENSE | 21 +++++++++++++++++++++ README.md | 2 ++ cmd_version.h | 8 ++++---- tutorial/README.md | 5 ++++- 4 files changed, 31 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..17e50d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Robert S. Harris + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 37f802d..0983b54 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,5 @@ To install subutan from the source: cd HowDeSBT make ``` +3. A usage tutorial can be found at +https://github.com/medvedevgroup/HowDeSBT/tree/master/tutorial diff --git a/cmd_version.h b/cmd_version.h index f13f227..1c61eae 100644 --- a/cmd_version.h +++ b/cmd_version.h @@ -11,10 +11,10 @@ class VersionCommand: public Command { public: - static const unsigned int major = 0; - static const unsigned int minor = 2; - static const unsigned int subMinor = 4; - static const std::uint32_t date = 0x20180419; + static const unsigned int major = 1; + static const unsigned int minor = 0; + static const unsigned int subMinor = 0; + static const std::uint32_t date = 0x20181030; public: VersionCommand(const std::string& name): Command(name) {} diff --git a/tutorial/README.md b/tutorial/README.md index e020195..de60cf3 100644 --- a/tutorial/README.md +++ b/tutorial/README.md @@ -17,7 +17,10 @@ _Note that this size is an overestimate._ However, tests have shown that overestimating the Bloom filter size has only a minor effect on the overall HowDe-SBT file sizes and query times. -Ntcard is available at https://github.com/bcgsc/ntCard. +Version 1.0.1 of ntcard was used, fetched as follows: +```bash +git clone https://github.com/bcgsc/ntCard --branch "1.0.1" +``` ### (2) Convert the fasta files to Bloom filter bit vectors.