diff --git a/README.md b/README.md new file mode 100644 index 0000000..4588fc2 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# tpeold + +Tpeold provides a Shiny interface for analyzing genes and finding TPE-OLD +candidates based on known TPE-OLD genes. + +## Installation + +You can install the development version of tepold from +[GitHub](https://github.com/) with: + +```r +# install.packages("devtools") +devtools::install_github("johrpan/tpeold") +``` + +## License + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU Affero General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) any +later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the +[GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html) +for more details.