doc: Fix typo in README.md

This commit is contained in:
Tommaso Gagliardoni 2025-09-06 23:05:19 +02:00
parent c1c679af47
commit 4e55a381a9

View file

@ -72,7 +72,7 @@ For security and consistency reasons, you cannot init/open/close nested volumes
## Installation <a id="user-content-installation"></a>
This implementation of Shufflecake consists of two components: a module for the Linux kernel (`dm-sflc`), and a `shufflecake` userland tool. Both are necessary in order to use Shufflecake. They have been tested on Linux kernel versions 6.1 (LTS), up to 6.15. The following instructions are given for Debian/Ubuntu and similar derivatives.
This implementation of Shufflecake consists of two components: a module for the Linux kernel (`dm-sflc`), and a `shufflecake` userland tool. Both are necessary in order to use Shufflecake. They have been tested on Linux kernel versions 6.1 (LTS), 6.8, and 6.16. The following instructions are given for Debian/Ubuntu and similar derivatives.
First of all, you need the kernel headers, device-mapper userspace library, and libgcrypt to compile the source. Use:
@ -122,7 +122,7 @@ When finished, you can unload the module with
sudo rmmod dm_sflc
```
You can only do this if no Shufflecake volume is currently open. Notice the hyphenation difference between `dm-sflc.ko` (the module file) and `dm_sflc` (the module name given by the kernel). This is standard practice.
You can only do this if no Shufflecake volume is currently open. Notice the spelling difference between `dm-sflc.ko` (the module file) and `dm_sflc` (the module name given by the kernel). This is standard practice.
### Initializing Device <a id="user-content-init"></a>