Move readme.jl to scripts/

.github/workflows/readme.yml

@@ -2,26 +2,21 @@
 name: README
 on:
   push:
+    branches:
+      - 'main'
     paths:
-      - 'HEADER.md'
-      - 'docs/src/index.md'
-      - 'docs/src/assets/**'
       - '.github/workflows/readme.yml'
-    branches:
-      - main
-  pull_request:
-      paths:
-        - 'HEADER.md'
-        - 'docs/src/index.md'
-        - 'docs/src/assets/**'
-        - '.github/workflows/readme.yml'
+      - 'docs/source/index.md'
+      - 'docs/source/assets/logo.svg'
+      - 'scripts/readme.jl'
+      - 'HEADER.md'
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
-      - run: julia --color=yes readme.jl
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+      - run: julia --color=yes scripts/readme.jl
       - run: |
           git config user.name github-actions
           git config user.email [email protected]

HEADER.md → scripts/readme.jl

@@ -1,4 +1,9 @@
 
+const introduction = "## Introduction"
+const header = """
+
+<!-- This file is generated by `.github/workflows/readme.yml`; do not edit directly. -->
+
 <p align="center"><img width="200px" src="docs/src/assets/logo.svg"/></p>
 
 <div align="center">
@@ -15,3 +20,8 @@
 </div>
 
 # PAndQ.jl
+
+"""
+
+write("README.md", header * introduction * replace(last(split(read(
+    "docs/src/index.md", String), introduction)), "jldoctest" => "julia"))