Update documentation

rust-zram-generator.spec

@@ -24,10 +24,11 @@ BuildRequires:  rust-packaging
 BuildRequires:  systemd-rpm-macros
 
 %global _description %{expand:
-This is a systemd unit generator that creates a unit file to create a
-zram device. To activate, copy
-/usr/share/doc/zram-generator/zram-generator.conf.example to
-/etc/systemd/zram-generator.conf and possibly edit to adjust the limits.}
+This is a systemd unit generator that enables swap on zram.
+(With zram, there is no physical swap device. Part of the avaialable RAM
+is used to store compressed pages, essentially trading CPU cycles for memory.)
+
+To activate, install %{crate}-defaults subpackage.}
 
 %description %{_description}
 
@@ -49,14 +50,14 @@ Recommends:     util-linux
 %{_systemdgeneratordir}/zram-generator
 %{_unitdir}/swap-create@.service
 
-%package     -n %{crate}-default
+%package     -n %{crate}-defaults
 Summary:        Default configuration for %{crate}
 BuildArch:      noarch
 
-%description -n %{crate}-default
+%description -n %{crate}-defaults
 %{summary}.
 
-%files
+%files       -n %{crate}-defaults
 %{_prefix}/lib/systemd/zram-generator.conf
 %endif
 

zram-generator.conf

@@ -1 +1,7 @@
+# This config file enables a /dev/zram0 device with the default settings:
+# — size — half of available RAM or 4GB, whichever is less
+# — compression — most likely lzo-rle
+#
+# To disable, uninstall rust-zram-defaults or create empty
+# /etc/systemd/zram-generator.conf file.
 [zram0]