Commit
Message
Changed Files (4)
-
modified .pre-commit-config.yml
diff --git a/.pre-commit-config.yml b/.pre-commit-config.yml index 42757cc..9dbf8b8 100644 --- a/.pre-commit-config.yml +++ b/.pre-commit-config.yml @@ -17,7 +17,8 @@ repos: - id: cargo-check - id: clippy - repo: https://git.sr.ht/~ololduck/pre-commit-hooks - rev: v0.2 + rev: v0.3.0 hooks: - id: check-version-bump - id: check-changelog-cliff + - id: check-readme-cargo-readme -
modified CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md index 652dee4..49c499b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## [unreleased] + +### 📚 Documentation + +- Fix main repo url ## [0.2.0] - 2026-05-31 ### 🚀 Features @@ -8,6 +13,10 @@ ### 📚 Documentation - Add Logos and fill up the README + +### ⚙️ Miscellaneous Tasks + +- Release v0.2.0 ## [0.1.1] - 2026-05-31 ### 🚀 Features -
modified README.md
diff --git a/README.md b/README.md index 0c25b60..85de9cf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Abbaye +# abbaye + +## Abbaye  @@ -31,34 +33,40 @@ Here's an example file structure: └── … ``` -## Why the name "Abbaye"? +### Why ? + +This piece of software is for people that can't or won't use a full-featured forge such as GitHub, GitLab, ForgeJo & others. These forges provide "release pages" that allow you to upload and distribute your software, as well as get a changelog. +Abbaye is made to be a simple, lightweight alternative to these forges, for the release/documentation parts. + +#### Why "Abbaye" ? -An [Abbaye](https://en.wikipedia.org/wiki/Abbaye) is a French word for Abbey. An Abbey is a type of monastery, on the big-ish side, but still a small, quiet place. +[Abbaye](https://en.wikipedia.org/wiki/Abbaye) is a French word for Abbey. An Abbey is a type of monastery, on the big-ish side, but still a small, quiet place. -Anyway, that's where you store your relics (your software distribution). +Anyway, that's where you store and display your relics (your software releases). -## Installation +### Installation -### Pre-built binaries +#### Pre-built binaries You can grab a pre-built binary from the [releases page](http://vit.am/~ololduck/abbaye/latest). The `-musl` binaries are statically linked and should run everywhere, while the `-gnu` binaries are dynamically linked and require a compatible system library(which is probably available if you're not using an exotic distribution). -### From source +#### From source To build from source, you need to have Rust installed. You can install Rust using [rustup](https://rustup.rs/). If you don't have rust installed, this project won't be of much use to you, as it currently only implements rust builders :stuck_out_tongue: -You can clone the [repository](https://sr.ht/~ololduck/abbaye) and build the project using `cargo build --release`. +You can clone the [repository](https://git.sr.ht/~ololduck/abbaye) and build the project using `cargo build --release`. -## Usage +### Usage Create a `abbaye.toml` configuration file in the root of your project. Here's an example configuration file to get you started: ```toml [site] name = "Abbaye" +base_url = "http://vit.am/~ololduck/abbaye/" # required for Atom feed generation [version_extractor] type = "git" # extract version from git tags -
modified src/main.rs
diff --git a/src/main.rs b/src/main.rs index c924b3b..4b2a588 100644 --- a/src/main.rs +++ b/src/main.rs @@ -31,11 +31,16 @@ //! └── … //! ``` //! -//! ## Why the name "Abbaye"? +//! ## Why ? //! -//! An [Abbaye](https://en.wikipedia.org/wiki/Abbaye) is a French word for Abbey. An Abbey is a type of monastery, on the big-ish side, but still a small, quiet place. +//! This piece of software is for people that can't or won't use a full-featured forge such as GitHub, GitLab, ForgeJo & others. These forges provide "release pages" that allow you to upload and distribute your software, as well as get a changelog. +//! Abbaye is made to be a simple, lightweight alternative to these forges, for the release/documentation parts. //! -//! Anyway, that's where you store and display your relics (your software distribution). +//! ### Why "Abbaye" ? +//! +//! [Abbaye](https://en.wikipedia.org/wiki/Abbaye) is a French word for Abbey. An Abbey is a type of monastery, on the big-ish side, but still a small, quiet place. +//! +//! Anyway, that's where you store and display your relics (your software releases). //! //! ## Installation //! @@ -50,7 +55,7 @@ //! To build from source, you need to have Rust installed. You can install Rust using [rustup](https://rustup.rs/). //! If you don't have rust installed, this project won't be of much use to you, as it currently only implements rust builders :stuck_out_tongue: //! -//! You can clone the [repository](https://sr.ht/~ololduck/abbaye) and build the project using `cargo build --release`. +//! You can clone the [repository](https://git.sr.ht/~ololduck/abbaye) and build the project using `cargo build --release`. //! //! ## Usage //! @@ -59,6 +64,7 @@ //! ```toml //! [site] //! name = "Abbaye" +//! base_url = "http://vit.am/~ololduck/abbaye/" # required for Atom feed generation //! //! [version_extractor] //! type = "git" # extract version from git tags