Extend readme and docs

Author: andreasKroepelin

.github/workflows/documentation.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main # update to match your development branch (master, main, dev, trunk, ...)
+    tags: [*v]
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      actions: write
+      contents: write
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "1"
+      - uses: julia-actions/cache@v2
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

README.md

@@ -6,9 +6,12 @@ The dataset has the following copyright notice
 > Copyright (c) [2016] [A. Carlier, K. Leonard, S. Hahmann, G. Morin, M. Collins]
 and is licensed under an MIT-License.
 
+The whole dataset is 1.8 MB large (zipped) and is only downloaded once when you
+use this package.
+
 ## Quickstart
 
-Install this package from the Genreal Registry:
+Install this package from the General Registry:
 ```julia
 julia> ]
 pkg> add The2DShapeStructureDataset

docs/make.jl

@@ -5,12 +5,11 @@ makedocs(
     sitename = "The2DShapeStructureDataset",
     format = Documenter.HTML(),
     modules = [The2DShapeStructureDataset],
-    remotes = nothing,
 )
 
 # Documenter can also automatically deploy documentation to gh-pages.
 # See "Hosting Documentation" and deploydocs() in the Documenter manual
 # for more information.
-#=deploydocs(
-    repo = "<repository url>"
-)=#
+deploydocs(
+    repo = "github.com/microscopic-image-analysis/The2DShapeStructureDataset.jl.git"
+)

src/The2DShapeStructureDataset.jl

@@ -1,7 +1,6 @@
 module The2DShapeStructureDataset
 @doc read(joinpath(dirname(@__DIR__), "README.md"), String) The2DShapeStructureDataset
 
-
 using Downloads
 using ZipArchives
 using JSON3