diff --git a/.codecov b/.codecov new file mode 100644 index 0000000..959972a --- /dev/null +++ b/.codecov @@ -0,0 +1 @@ +comment: false \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8c960ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.jl.cov +*.jl.*.cov +*.jl.mem diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..dfc2b89 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +# Documentation: http://docs.travis-ci.com/user/languages/julia/ +language: julia +os: + - linux + - osx +julia: + - 0.6 + - nightly +notifications: + email: false +after_success: +# build documentation + - julia -e 'cd(Pkg.dir("BibTeX")); Pkg.add("Documenter"); include(joinpath("docs", "make.jl"))' +# push coverage results to Codecov + - julia -e 'cd(Pkg.dir("BibTeX")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())' diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..b17ba1d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,41 @@ +The BibTeX.jl package is licensed under the MIT "Expat" License: + + +> Copyright (c) 2017: Brandon Taylor. +> +> +> 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 new file mode 100644 index 0000000..96279ba --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# BibTeX + +[![travis badge][travis_badge]][travis_url] +[![appveyor badge][appveyor_badge]][appveyor_url] +[![codecov badge][codecov_badge]][codecov_url] + +## Documentation [here][documenter_latest] + +Change documentation link to `documenter_stable` once published! + +[travis_badge]: https://travis-ci.org/bramtayl/BibTeX.jl.svg?branch=master +[travis_url]: https://travis-ci.org/bramtayl/BibTeX.jl + +[appveyor_badge]: https://ci.appveyor.com/api/projects/status/github/bramtayl/BibTeX.jl?svg=true&branch=master +[appveyor_url]: https://ci.appveyor.com/project/bramtayl/bibtex-jl + +[codecov_badge]: http://codecov.io/github/bramtayl/BibTeX.jl/coverage.svg?branch=master +[codecov_url]: http://codecov.io/github/bramtayl/BibTeX.jl?branch=master + +[documenter_stable]: https://bramtayl.github.io/BibTeX.jl/stable +[documenter_latest]: https://bramtayl.github.io/BibTeX.jl/latest diff --git a/REQUIRE b/REQUIRE new file mode 100644 index 0000000..6ac7274 --- /dev/null +++ b/REQUIRE @@ -0,0 +1 @@ +julia 0.6 \ No newline at end of file diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..d469346 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,26 @@ +environment: + matrix: + - JULIAVERSION: "julialang/bin/winnt/x86/0.6/julia-0.6-latest-win32.exe" + - JULIAVERSION: "julialang/bin/winnt/x64/0.6/julia-0.6-latest-win64.exe" + - JULIAVERSION: "julianightlies/bin/winnt/x86/julia-latest-win32.exe" + - JULIAVERSION: "julianightlies/bin/winnt/x64/julia-latest-win64.exe" +branches: + only: + - master + - /release-.*/ +notifications: + - provider: Email + on_build_success: false + on_build_failure: false + on_build_status_changed: false +install: + - ps: (new-object net.webclient).DownloadFile( + $("http://s3.amazonaws.com/"+$env:JULIAVERSION), + "C:\projects\julia-binary.exe") + - C:\projects\julia-binary.exe /S /D=C:\projects\julia +build_script: + - IF EXIST .git\shallow (git fetch --unshallow) + - C:\projects\julia\bin\julia -e "versioninfo(); + Pkg.clone(pwd(), \"BibTeX\"); Pkg.build(\"BibTeX\")" +test_script: + - C:\projects\julia\bin\julia -e "Pkg.test(\"BibTeX\")" diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a303fff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..4111bfb --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,8 @@ +import Documenter + +Documenter.deploydocs( + repo = "github.com/bramtayl/BibTeX.jl.git", + target = "build", + deps = nothing, + make = nothing +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..b8d4f39 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,8 @@ +# BibTeX.jl + +```@index +``` + +```@autodocs +Modules = [BibTeX] +``` diff --git a/src/BibTeX.jl b/src/BibTeX.jl new file mode 100644 index 0000000..a731879 --- /dev/null +++ b/src/BibTeX.jl @@ -0,0 +1,17 @@ +module BibTeX + +""" + test_function() + +Return 1 + +```jldoctest +julia> import BibTeX + +julia> BibTeX.test_function() +2 +``` +""" +test_function() = 1 + +end diff --git a/test/REQUIRE b/test/REQUIRE new file mode 100644 index 0000000..002f6da --- /dev/null +++ b/test/REQUIRE @@ -0,0 +1 @@ +Documenter \ No newline at end of file diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..6d89af3 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,19 @@ +using BibTeX + +import Documenter +Documenter.makedocs( + modules = [BibTeX], + format = :html, + sitename = "BibTeX.jl", + root = joinpath(dirname(dirname(@__FILE__)), "docs"), + pages = Any["Home" => "index.md"], + strict = true, + linkcheck = true, + checkdocs = :exports, + authors = "Brandon Taylor" +) + +using Base.Test + +# write your own tests here +@test 1 == 2