Cleanup towards Release (#39)

- Remove dev dependencies
- Add compat entries for QED dependencies

.JuliaFormatter.toml

@@ -1,2 +1 @@
 style = "blue"
-

.github/workflows/BuildDelopyDoc.yml → .github/workflows/BuildDeployDoc.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
-          version: "1.9"
+          version: "1.10"
       - name: Add custom registry
         run: |
           julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry.git"));'

.github/workflows/formatter.yaml

@@ -9,7 +9,7 @@ jobs:
       - name: install Julia
         uses: julia-actions/setup-julia@v1
         with:
-          version: 1.9
+          version: 1.10
       - name: Install Julia requirements
         run: julia --project=${GITHUB_WORKSPACE}/.formatting -e 'import Pkg; Pkg.instantiate()'
       - name: Check code style

.gitignore

@@ -1,4 +1,4 @@
-/docs/build/
+docs/build/
 
 # 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

.gitlab-ci.yml

@@ -63,7 +63,7 @@ unit_tests_nightly:
   allow_failure: true
 
 generate_integration_tests:
-  image: julia:1.9
+  image: julia:1.10
   stage: generate_integration_test
   script:
     # extract package name
@@ -102,8 +102,8 @@ run_integration_tests:
         job: generate_integration_tests
     strategy: depend
 
-verify-unit-test-deps_julia1.9:
-  image: julia:1.9
+verify-unit-test-deps_julia1.10:
+  image: julia:1.10
   stage: verify-unit-test-deps
   script:
     - apt update && apt install -y git

Project.toml

@@ -16,6 +16,8 @@ QEDcore = "35dc0263-cb5f-4c33-a114-1d7f54ab753e"
 QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
 
 [compat]
+QEDbase = "0.2.2"
+QEDcore = "0.1"
 IntervalSets = "0.7"
 QuadGK = "2"
 julia = "1.6"

README.md

@@ -4,40 +4,25 @@
 [![Doc Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://qedjl-project.github.io/QEDfields.jl/dev)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
-:warning: This package is under construction and only contains dummy functionality for testing.
-
-:warning: currently this is based on a dev-version of QEDcore. Please make sure that you use the QEDjl registry below.
-
 ## Installation
 
 To install the current stable version of `QEDfields.jl` you may use the standard julia package manager within the julia REPL
 
 ```julia
 julia> using Pkg
-
-# add local registry, where QEDfields is registered
-julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry"))
-# add general registry again to have it join the local registry
-julia> Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"))
-
 julia> Pkg.add("QEDfields")
 ```
 
 or you use the Pkg prompt by hitting `]` within the Julia REPL and then type
 
 ```julia
-# add local registry, where QEDfields is registered
-(@v1.9) pkg> registry add https://github.com/QEDjl-project/registry
-# add general registry again to have it join the local registry
-(@v1.9) pkg> registry add https://github.com/JuliaRegistries/General
-
-(@v1.9) pkg> add QEDfields
+(@v1.10) pkg> add QEDfields
 ```
 
 To install the locally downloaded package on Windows, change to the parent directory and type within the Pkg prompt
 
 ```julia
-(@v1.9) pkg> add ./QEDfields.jl
+(@v1.10) pkg> add ./QEDfields.jl
 ```
 
 # Development