From ae0e2bcce442267b8d673604d9d8d8c58f1e5df9 Mon Sep 17 00:00:00 2001 From: Uwe Hernandez Acosta Date: Thu, 6 Jun 2024 11:03:05 +0200 Subject: [PATCH] added package template --- .JuliaFormatter.toml | 2 ++ .github/dependabot.yml | 7 +++++++ .gitignore | 27 +++------------------------ LICENSE | 2 +- Project.toml | 13 +++++++++++++ README.md | 6 ++++++ docs/Project.toml | 3 +++ docs/make.jl | 23 +++++++++++++++++++++++ docs/src/index.md | 14 ++++++++++++++ src/QEDcore.jl | 5 +++++ test/runtests.jl | 6 ++++++ 11 files changed, 83 insertions(+), 25 deletions(-) create mode 100644 .JuliaFormatter.toml create mode 100644 .github/dependabot.yml create mode 100644 Project.toml create mode 100644 README.md create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md create mode 100644 src/QEDcore.jl create mode 100644 test/runtests.jl diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml new file mode 100644 index 0000000..d808d22 --- /dev/null +++ b/.JuliaFormatter.toml @@ -0,0 +1,2 @@ +# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options +style = "blue" diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..700707c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" # Location of package manifests + schedule: + interval: "weekly" diff --git a/.gitignore b/.gitignore index 29126e4..5a16984 100644 --- a/.gitignore +++ b/.gitignore @@ -1,24 +1,3 @@ -# Files generated by invoking Julia with --code-coverage -*.jl.cov -*.jl.*.cov - -# Files generated by invoking Julia with --track-allocation -*.jl.mem - -# System-specific files and directories generated by the BinaryProvider and BinDeps packages -# They contain absolute paths specific to the host computer, and so should not be committed -deps/deps.jl -deps/build.log -deps/downloads/ -deps/usr/ -deps/src/ - -# Build artifacts for creating documentation generated by the Documenter package -docs/build/ -docs/site/ - -# File generated by Pkg, the package manager, based on a corresponding Project.toml -# It records a fixed state of all packages used by the project. As such, it should not be -# committed for packages, but should be committed for applications that require a static -# environment. -Manifest.toml +/Manifest.toml +/docs/Manifest.toml +/docs/build/ diff --git a/LICENSE b/LICENSE index c0fdf15..bbc708b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 QED.jl ecosystem +Copyright (c) 2024 Uwe Hernandez Acosta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/Project.toml b/Project.toml new file mode 100644 index 0000000..46a5ec3 --- /dev/null +++ b/Project.toml @@ -0,0 +1,13 @@ +name = "QEDcore" +uuid = "35dc0263-cb5f-4c33-a114-1d7f54ab753e" +authors = ["Uwe Hernandez Acosta "] +version = "0.0.1-DEV" + +[compat] +julia = "1.6" + +[extras] +Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + +[targets] +test = ["Test"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..07d24bd --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# QEDcore + +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://QEDjl-project.github.io/QEDcore.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://QEDjl-project.github.io/QEDcore.jl/dev/) +[![Build Status](https://github.com/QEDjl-project/QEDcore.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/QEDjl-project/QEDcore.jl/actions/workflows/CI.yml?query=branch%3Amain) +[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..2292a04 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +QEDcore = "35dc0263-cb5f-4c33-a114-1d7f54ab753e" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..70e3b0e --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,23 @@ +using QEDcore +using Documenter + +DocMeta.setdocmeta!(QEDcore, :DocTestSetup, :(using QEDcore); recursive=true) + +makedocs(; + modules=[QEDcore], + authors="Uwe Hernandez Acosta ", + sitename="QEDcore.jl", + format=Documenter.HTML(; + canonical="https://QEDjl-project.github.io/QEDcore.jl", + edit_link="main", + assets=String[], + ), + pages=[ + "Home" => "index.md", + ], +) + +deploydocs(; + repo="github.com/QEDjl-project/QEDcore.jl", + devbranch="main", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..da47691 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,14 @@ +```@meta +CurrentModule = QEDcore +``` + +# QEDcore + +Documentation for [QEDcore](https://github.com/QEDjl-project/QEDcore.jl). + +```@index +``` + +```@autodocs +Modules = [QEDcore] +``` diff --git a/src/QEDcore.jl b/src/QEDcore.jl new file mode 100644 index 0000000..c2f5cc7 --- /dev/null +++ b/src/QEDcore.jl @@ -0,0 +1,5 @@ +module QEDcore + +# Write your package code here. + +end diff --git a/test/runtests.jl b/test/runtests.jl new file mode 100644 index 0000000..2290068 --- /dev/null +++ b/test/runtests.jl @@ -0,0 +1,6 @@ +using QEDcore +using Test + +@testset "QEDcore.jl" begin + # Write your tests here. +end