diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c584e90 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +dracut +==== + +dracut is an event driven initramfs infrastructure. + +[](docs/CODE_OF_CONDUCT.md) + +dracut (the tool) is used to create an initramfs image by copying tools +and files from an installed system and combining it with the +dracut framework, usually found in /usr/lib/dracut/modules.d. + +Unlike other implementations, dracut hard-codes as little +as possible into the initramfs. The initramfs has +(basically) one purpose in life -- getting the rootfs mounted so that +we can transition to the real rootfs. This is all driven off of +device availability. Therefore, instead of scripts hard-coded to do +various things, we depend on udev to create device nodes for us and +then when we have the rootfs's device node, we mount and carry on. +This helps to keep the time required in the initramfs as little as +possible so that things like a 5 second boot aren't made impossible as +a result of the very existence of an initramfs. + +Most of the initramfs generation functionality in dracut is provided by a bunch +of generator modules that are sourced by the main dracut script to install +specific functionality into the initramfs. They live in the modules.d +subdirectory, and use functionality provided by dracut-functions to do their +work. + +Documentation: + - [Introduction](man/dracut.asc) + - [User Manual](man/dracut.usage.asc) + +Currently dracut is developed on [github.com](https://github.com/dracutdevs/dracut). + +The release tarballs are [here](https://github.com/dracutdevs/dracut/releases). + +Gitter (chat): + - https://gitter.im/dracutdevs/Lobby + +See [News](NEWS.md) for information about changes in the releases and +the [Wiki](https://github.com/dracutdevs/dracut/wiki) to share information. + +See the github issue tracker for things which still need to be done and [Hacking](docs/HACKING.md) +for some instructions on how to get started. There is also a mailing list +that is being used for the discussion -- initramfs@vger.kernel.org. +It is a typical vger list, send mail to majordomo@vger.kernel.org with body +of 'subscribe initramfs email@host.com' + + +Licensed under the GPLv2 |