diff --git a/LICENSE b/LICENSE index 82917ea..043c4fc 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2020, Thomas A. Christensen II +Copyright (c) 2021, Thomas A. Christensen II All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/Project.toml b/Project.toml index 9c8974f..1b422d7 100644 --- a/Project.toml +++ b/Project.toml @@ -10,3 +10,12 @@ DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0" Dates = "ade2ca70-3891-5945-98fb-dc099432e06a" Gtk = "4c0ca9eb-093a-5379-98c5-f87ac0bbbf44" LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" + +[compat] +julia = "1.3" + +[extras] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[targets] +test = ["Test"] diff --git a/README.md b/README.md index 38996bd..8cbe162 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # [:cow:]: beefblup +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://millironx.github.io/beefblup/stable) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MillironX.github.io/beefblup/dev) +[![Build Status](https://travis-ci.com/millironx/beefblup.svg?branch=master)](https://travis-ci.com/millironx/beefblup) +[![Coverage](https://codecov.io/gh/millironx/beefblup/branch/master/graph/badge.svg)](https://codecov.io/gh/millironx/beefblup) +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![GitHub license](https://img.shields.io/github/license/MillironX/beefblup)](https://github.com/MillironX/beefblup/blob/master/LICENSE.md) [![Join the chat at https://gitter.im/beefblup/community](https://badges.gitter.im/beefblup/community.svg)](https://gitter.im/beefblup/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Github all releases](https://img.shields.io/github/downloads/MillironX/beefblup/total.svg)](https://GitHub.com/MillironX/beefblup/releases) diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..21b8b1d --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +BeefBLUP = "4c4dd571-0773-455e-9a95-72727008e3f4" +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..00da129 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,24 @@ +using BeefBLUP +using Documenter + +DocMeta.setdocmeta!(BeefBLUP, :DocTestSetup, :(using BeefBLUP); recursive=true) + +makedocs(; + modules=[BeefBLUP], + authors="Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors", + repo="https://github.com/MillironX/BeefBLUP.jl/blob/{commit}{path}#{line}", + sitename="BeefBLUP.jl", + format=Documenter.HTML(; + prettyurls=get(ENV, "CI", "false") == "true", + canonical="https://MillironX.github.io/BeefBLUP.jl", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/MillironX/BeefBLUP.jl", + devbranch="develop", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..35a45b5 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = BeefBLUP +``` + +# BeefBLUP + +Documentation for [BeefBLUP](https://github.com/MillironX/BeefBLUP.jl). + +```@index +``` + +```@autodocs +Modules = [BeefBLUP] +``` diff --git a/test/runtests.jl b/test/runtests.jl index 2fca2e7..9075615 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,2 +1,6 @@ using BeefBLUP using Test + +@testset "BeefBLUP.jl" begin + # Write your tests here. +end