diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..99e2cea --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.jl.*.cov +*.jl.cov +*.jl.mem +.DS_Store +/Manifest.toml +/dev/ +/docs/build/ +/docs/site/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..21b2985 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,26 @@ +# Documentation: http://docs.travis-ci.com/user/languages/julia/ +language: julia +os: + - linux + - osx +julia: + - 1.0 + - nightly +matrix: + allow_failures: + - julia: nightly + fast_finish: true +notifications: + email: false +after_success: + - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())' +jobs: + include: + - stage: Documentation + julia: 1.0 + script: julia --project=docs -e ' + using Pkg; + Pkg.develop(PackageSpec(path=pwd())); + Pkg.instantiate(); + include("docs/make.jl");' + after_success: skip diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b02776a --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2019 Jacob Quinn + +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/Project.toml b/Project.toml new file mode 100644 index 0000000..97bd154 --- /dev/null +++ b/Project.toml @@ -0,0 +1,13 @@ +name = "StructTypes" +uuid = "856f2bd8-1eba-4b0a-8007-ebc267875bd4" +authors = ["Jacob Quinn"] +version = "0.1.0" + +[compat] +julia = "1" + +[extras] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[targets] +test = ["Test"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..553c976 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# StructTypes + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://quinnj.github.io/StructTypes.jl/stable) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://quinnj.github.io/StructTypes.jl/dev) +[![Build Status](https://travis-ci.com/quinnj/StructTypes.jl.svg?branch=master)](https://travis-ci.com/quinnj/StructTypes.jl) +[![Codecov](https://codecov.io/gh/quinnj/StructTypes.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/quinnj/StructTypes.jl) diff --git a/docs/Manifest.toml b/docs/Manifest.toml new file mode 100644 index 0000000..485804e --- /dev/null +++ b/docs/Manifest.toml @@ -0,0 +1,93 @@ +# This file is machine-generated - editing it directly is not advised + +[[Base64]] +uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" + +[[Dates]] +deps = ["Printf"] +uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" + +[[Distributed]] +deps = ["Random", "Serialization", "Sockets"] +uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b" + +[[DocStringExtensions]] +deps = ["LibGit2", "Markdown", "Pkg", "Test"] +git-tree-sha1 = "88bb0edb352b16608036faadcc071adda068582a" +uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" +version = "0.8.1" + +[[Documenter]] +deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"] +git-tree-sha1 = "d45c163c7a3ae293c15361acc52882c0f853f97c" +uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +version = "0.23.4" + +[[InteractiveUtils]] +deps = ["Markdown"] +uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" + +[[JSON]] +deps = ["Dates", "Mmap", "Parsers", "Unicode"] +git-tree-sha1 = "b34d7cef7b337321e97d22242c3c2b91f476748e" +uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" +version = "0.21.0" + +[[LibGit2]] +deps = ["Printf"] +uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" + +[[Libdl]] +uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" + +[[Logging]] +uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" + +[[Markdown]] +deps = ["Base64"] +uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" + +[[Mmap]] +uuid = "a63ad114-7e13-5084-954f-fe012c677804" + +[[Parsers]] +deps = ["Dates", "Test"] +git-tree-sha1 = "c56ecb484f286639f161e712b8311f5ab77e8d32" +uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" +version = "0.3.8" + +[[Pkg]] +deps = ["Dates", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "UUIDs"] +uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" + +[[Printf]] +deps = ["Unicode"] +uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" + +[[REPL]] +deps = ["InteractiveUtils", "Markdown", "Sockets"] +uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" + +[[Random]] +deps = ["Serialization"] +uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" + +[[SHA]] +uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" + +[[Serialization]] +uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" + +[[Sockets]] +uuid = "6462fe0b-24de-5631-8697-dd941f90decc" + +[[Test]] +deps = ["Distributed", "InteractiveUtils", "Logging", "Random"] +uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[[UUIDs]] +deps = ["Random", "SHA"] +uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" + +[[Unicode]] +uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..dfa65cd --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,2 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..a4805f7 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,17 @@ +using Documenter, StructTypes + +makedocs(; + modules=[StructTypes], + format=Documenter.HTML(), + pages=[ + "Home" => "index.md", + ], + repo="https://github.com/quinnj/StructTypes.jl/blob/{commit}{path}#L{line}", + sitename="StructTypes.jl", + authors="Jacob Quinn", + assets=String[], +) + +deploydocs(; + repo="github.com/quinnj/StructTypes.jl", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..be038e5 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,8 @@ +# StructTypes.jl + +```@index +``` + +```@autodocs +Modules = [StructTypes] +``` diff --git a/src/StructTypes.jl b/src/StructTypes.jl new file mode 100644 index 0000000..e770046 --- /dev/null +++ b/src/StructTypes.jl @@ -0,0 +1,5 @@ +module StructTypes + +greet() = print("Hello World!") + +end # module diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..62854e5 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using StructTypes +using Test + +@testset "StructTypes.jl" begin + # Write your own tests here. +end