Commit

Message

Changed Files (3)

• added CHANGELOG.md

  diff --git a/CHANGELOG.md b/CHANGELOG.md

  new file mode 100644

  index 0000000..1a0403b

  --- /dev/null

  +++ b/CHANGELOG.md

  @@ -0,0 +1,6 @@

  +## [unreleased]

  +

  +### 🚀 Features

  +

  +- Add core site generator with builders and templates

  +- Add changelog task and wire into build

• modified README.md

  diff --git a/README.md b/README.md

  index 548ed60..ce424dd 100644

  --- a/README.md

  +++ b/README.md

  @@ -1,5 +1,31 @@

  -# abbaye2

  +# Abbaye

  -## Installation

  +Abbaye is a Static Site Generator (SSG) for your software. As GitHub,

  +Gitea, Forgejo and consorts offer, Abbaye can be used to generate a

  +website with your software's presentation, documentation, and distribution, per version.

  -## Configuration

  +Here's an example file structure:

  +

  +```

  +.

  +├── index.html # the main page of the website, enabling choosing a version, defaults to "latest" (contains a list of available versions and a iframe to the selected version?)

  +├── latest -> v2.0.0 # symlink to the latest version (biggest version number)

  +├── v1.0.0/ # the directory containing the version 1.0.0 of the software

  +│ ├── index.html # the main page of the version 1.0.0, from the README.md file.

  +│ │ # Contains a sidebar with links to the documentation and distribution.

  +│ │ # After the readme content, A changelog is displayed.

  +│ ├── docs/ # the directory containing the documentation of the version 1.0.0

  +│ │ ├── index.html # the main page of the documentation of the version 1.0.0

  +│ │ └── …

  +│ ├── docs.tar.gz # the tarball containing the documentation of the version 1.0.0

  +│ └── dist/ # the directory containing the distribution of the version 1.0.0

  +│ ├── source.tgz # the source code of the version 1.0.0

  +│ ├── mybin-v1.0.0-x86_64-unknown-linux-gnu

  +│ └── mybin-v1.0.0-x86_64-unknown-linux-musl

  +└── v2.0.0/ # the directory containing the version 2.0.0 of the software

  + ├── index.html # the main page of the version 2.0.0

  + ├── …

  + └── …

  +```

  +

  +License: AGPL-3.0-or-later

• modified mise.toml

  diff --git a/mise.toml b/mise.toml

  index c2885e7..b18951d 100644

  --- a/mise.toml

  +++ b/mise.toml

  @@ -33,15 +33,20 @@ run = [

  ]

  sources = ["src/main.rs"]

  +[tasks.generate-changelog]

  +description = "generates a changelog from git commits"

  +run = ["git-cliff --output CHANGELOG.md"]

  +outputs = ["CHANGELOG.md"]

  +

  [tasks.build]

  alias = "b"

  -depends = ["generate-readme"]

  +depends = ["generate-readme", "generate-changelog"]

  description = "build the project"

  run = ["cargo build"]

  sources = ["Cargo.toml", "Cargo.lock", "*.rs", "**/*.rs"]

  [tasks."build::release"]

  -depends = ["generate-readme"]

  +depends = ["generate-readme", "generate-changelog"]

  description = "build the project in release mode"

  run = ["cargo build --release"]

  sources = ["Cargo.toml", "Cargo.lock", "*.rs", "**/*.rs"]