Update README

This commit is contained in:
Dennis ten Hoove 2024-03-31 16:23:10 +02:00
parent 5f6d2b06d0
commit 29d3d62145

View file

@ -1,11 +1,10 @@
# Arkdep
Toolkit for building, deploying and maintaining an immutable, btrfs-based, multi-root system.
> [!NOTE]
> Arkdep is still in active development, no more breaking changes are planned since all core functionality is now in, however breaking changes might still happen as the project moves toward stable. The current codebase has also yet to be thoroughly tested, there may be lingering bugs or other issues
## About
Arkdep is the set of tools providing immutability to Arkane Linux. It attempts to differentiate itself from other similar tools by being "stupidly simple", hackable, flexible, and having the usability of the tooling be a top priority.
> [!NOTE]
> Arkdep is still in active development, breaking changes might still happen as the project moves toward stable. The current codebase has also yet to be thoroughly tested, there may be lingering bugs or other issues
## Documentation and usage
For documentation refer to the [Arkane Linux Arkdep Documentation](https://docs.arkanelinux.org/arkdep/arkdep/), or the Markdown documents over on either [GitHub](https://github.com/arkanelinux/docs.arkanelinux.org/tree/main/docs/arkdep) or [Codeberg](https://codeberg.org/arkanelinux/docs.arkanelinux.org/src/branch/main/docs/arkdep).