From 3822376fda8ad1bfc01c0334bae33a9159d8c356 Mon Sep 17 00:00:00 2001 From: Daniel Salazar Date: Wed, 30 Jul 2025 14:15:00 -0500 Subject: [PATCH] refac(doc): #1439 update readme - Update README.md with deprecation notice. Signed-off-by: Daniel Salazar --- README.md | 14 ++++++++++++-- docs/src/contributing.md | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 96538079..faae1f7a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +# ⚠️ Deprecation notice ⚠️ + +After a [thorough review](https://gitlab.com/fluidattacks/universe/-/issues/14974#note_2427180773) of Makes and other build system alternatives, Fluid Attacks has decided to transition fully to [Nix Flakes](https://nixos.wiki/wiki/Flakes) for all our builds. + +This decision brings significant benefits, including the opportunity to rely on and contribute to the incredible Nix community instead of maintaining our own build system. + +It also means that Makes is no longer maintained and will be archived. + +More information can be found at https://github.com/fluidattacks/makes/issues/1439. + # 🦄 Makes A CI/CD framework @@ -52,11 +62,11 @@ It is ## Installation -[Installation](https://makes.fluidattacks.tech/getting-started/#installation) +[Installation](https://github.com/fluidattacks/makes/blob/main/docs/src/getting-started.md) ## Documentation -See https://makes.fluidattacks.tech +You can run `m . /docs/dev` to serve the docs site on localhost or directly see the `docs/src` directory. ## Issues diff --git a/docs/src/contributing.md b/docs/src/contributing.md index f75fa686..0913bcce 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -29,7 +29,7 @@ If you're adding new files, make sure to `git add` them first. #### Adding documentation - All changes must be documented in the same PR. -- You can run `m . /docs/dev` to serve the [docs site](https://makes.fluidattacks.tech) +- You can run `m . /docs/dev` to serve the docs site on localhost. #### Adding tests