From 120047e2eb3f1ec4fe5e739020971e764d25b812 Mon Sep 17 00:00:00 2001 From: duyiwei Date: Wed, 21 Jun 2023 03:15:59 +0000 Subject: [PATCH] Specification NestOS Project Component Description File Signed-off-by: duyiwei --- README.md | 47 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 55cc3ab..0027a76 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,50 @@ #### 介绍 This is a systemd unit generator that enables swap on zram. - -#### 软件架构 -软件架构说明 +(With zram, there is no physical swap device. Part of the available RAM +is used to store compressed pages, essentially trading CPU cycles for memory.) +To activate, install zram-generator-defaults subpackage. #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +Install zram-generator rpm package: + +yum install zram-generator + +To install directly from sources, execute make build && sudo make install NOBUILD=true: + +-zram-generator binary is installed in the systemd system generator directory (usually /usr/lib/systemd/system-generators/) +-zram-generator(8) and zram-generator.conf(5) manpages are installed into /usr/share/man/manN/, this requires ronn. +-units/systemd-zram-setup@.service is copied into the systemd system unit directory (usually /usr/lib/systemd/system/) +-zram-generator.conf.example is copied into /usr/share/doc/zram-generator/ You need though create your own config file at one of the locations listed above. #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +A default config file may be located in /usr. This generator checks the following locations: + +-/run/systemd/zram-generator.conf +-/etc/systemd/zram-generator.conf +-/usr/local/lib/systemd/zram-generator.conf +-/usr/lib/systemd/zram-generator.conf +… and the first file found in that list wins. + +In addition, "drop-ins" will be loaded from .conf files in /etc/systemd/zram-generator.conf.d/, /usr/lib/systemd/zram-generator.conf.d/, etc. + +The main configuration file is read before any of the drop-ins and has the lowest precedence; entries in the drop-in files override entries in the main configuration file. + +See systemd.unit(5) for a detailed description of this logic. + +See zram-generator.conf.example for a list of available settings. #### 参与贡献 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +master分支使用最新的上游版本，如果检测到上游有最新版本发布，先形成issue后再提交对应PR更新，流程如下。 +1. 提交issue +2. Fork 本仓库 +3. 新建 Feat_xxx 分支 +4. 提交代码 +5. 新建 Pull Request #### 特技 -- Gitee