Add developer instructions (#93)

* Add changelog and NEWS.md

* add developer instrautions to the landing page

Author: andrewwinters5000

.gitignore

@@ -2,6 +2,7 @@
 out*/
 docs/build
 docs/src/authors.md
+docs/src/changelog.md
 docs/src/code_of_conduct.md
 docs/src/contributing.md
 docs/src/index.md

NEWS.md

@@ -0,0 +1,32 @@
+# Changelog
+
+HOHQMesh.jl follows the interpretation of
+[semantic versioning (semver)](https://julialang.github.io/Pkg.jl/dev/compatibility/#Version-specifier-format-1)
+used in the Julia ecosystem. Notable changes will be documented in this file
+for human readability.
+
+## Changes in the v0.2 lifecycle
+
+#### Added
+
+- New option and tutorial for a symmetric mesh [#57]
+- Optional arguments to `generate_mesh` command [#52]
+- Move plotting routines into a package extension [#51]
+
+#### Changed
+
+#### Deprecated
+
+#### Removed
+
+## Changes in the v0.1 lifecycle
+
+#### Added
+
+- Interactive capability via HQMTool and testing [#15]
+
+#### Changed
+
+#### Deprecated
+
+#### Removed

README.md

@@ -24,8 +24,10 @@ If you have not yet installed Julia, please [follow the instructions for your
 operating system](https://julialang.org/downloads/platform/). HOHQMesh.jl works
 with Julia v1.6 and above.
 
-HOHQMesh.jl is a registered Julia package. Hence, you can install it by executing
-the following commands in the Julia REPL:
+
+### For users
+HOHQMesh.jl and its related tools are registered Julia packages. Hence, you
+can install it by executing the following commands in the Julia REPL:
 ```julia
 julia> import Pkg; Pkg.add("HOHQMesh")
 ```
@@ -35,6 +37,39 @@ mesh generator, which is available via the Julia package
 [HOHQMesh_jll.jl](https://github.com/JuliaBinaryWrappers/HOHQMesh_jll.jl)
 and which is automatically installed as a dependency.
 
+The available visualization functionality uses [Makie.jl](https://github.com/JuliaPlots/Makie.jl/).
+A Makie backend, such as [GLMakie.jl](https://github.com/JuliaPlots/GLMakie.jl/), can
+be installed in addition to HOHQMesh
+```julia
+julia> using Pkg; Pkg.add("GLMakie")
+```
+
+
+### For developers
+If you plan on editing HOHQMesh.jl itself, you can download HOHQMesh.jl
+locally and use the code from the cloned directory:
+```bash
+git clone git@github.com:trixi-framework/HOHQMesh.jl.git
+cd HOHQMesh.jl
+mkdir run
+cd run
+julia --project=. -e 'using Pkg; Pkg.develop(PackageSpec(path=".."))' # Install local HOHQMesh.jl clone
+julia --project=. -e 'using Pkg; Pkg.add("GLMakie")' # Install additional packages for plotting
+```
+Note that the additional package is optional and can be omitted.
+
+If you installed HOHQMesh.jl this way, you always have to start Julia with the `--project`
+flag set to your `run` directory, e.g.,
+```bash
+julia --project=.
+```
+if already inside the `run` directory or
+```bash
+julia --project=run
+```
+if inside the repository root directory.
+
+
 ## Usage
 In the Julia REPL, you can load HOHQMesh with
 ```julia

docs/Project.toml

@@ -1,6 +1,8 @@
 [deps]
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 HOHQMesh = "e4f4c7b8-17cb-445a-93c5-f69190ed6c8c"
 
 [compat]
+Changelog = "1.1"
 Documenter = "1.3"

docs/make.jl

@@ -1,6 +1,7 @@
 using Documenter
 import Pkg
 using HOHQMesh
+using Changelog: Changelog
 
 # Define module-wide setups such that the respective modules are available in doctests
 DocMeta.setdocmeta!(HOHQMesh,     :DocTestSetup, :(using HOHQMesh);     recursive=true)
@@ -39,6 +40,24 @@ readme_text = replace(readme_text,
                       r"\[comment\].*\n" => "")    # remove comments
 write(joinpath(@__DIR__, "src", "index.md"), readme_text)
 
+# Create changelog
+Changelog.generate(Changelog.Documenter(),                        # output type
+                   joinpath(@__DIR__, "..", "NEWS.md"),           # input file
+                   joinpath(@__DIR__, "src", "changelog_tmp.md"); # output file
+                   repo = "trixi-framework/HOHQMesh.jl",          # default repository for links
+                   branch = "main",)
+# Fix edit URL of changelog
+open(joinpath(@__DIR__, "src", "changelog.md"), "w") do io
+    for line in eachline(joinpath(@__DIR__, "src", "changelog_tmp.md"))
+        if startswith(line, "EditURL")
+            line = "EditURL = \"https://github.com/trixi-framework/HOHQMesh.jl/blob/main/NEWS.md\""
+        end
+        println(io, line)
+    end
+end
+# Remove temporary file
+rm(joinpath(@__DIR__, "src", "changelog_tmp.md"))
+
 # Make documentation
 makedocs(;
     # Specify modules for which docstrings should be shown
@@ -75,11 +94,12 @@ makedocs(;
             "GitHub & Git" => "github-git.md",
             "Testing" => "testing.md",
         ],
+        "Reference" => "reference.md",
+        "Changelog" => "changelog.md",
         "Authors" => "authors.md",
         "Contributing" => "contributing.md",
         "Code of Conduct" => "code_of_conduct.md",
-        "License" => "license.md",
-        "Reference" => "reference.md"])
+        "License" => "license.md"])
 
 deploydocs(
     repo = "github.com/trixi-framework/HOHQMesh.jl",