From 013ecfb3e7c2ea5c3eab18cc09376198d87da183 Mon Sep 17 00:00:00 2001 From: ngn Date: Wed, 1 May 2024 23:11:55 +0300 Subject: [PATCH] update: Add basic info to README --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 563b542..7ab55ac 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,26 @@ -# xcfg | simple xorg configuration tool -`xcfg` is a simple tool that lets you install desktop environments, -and window managers and adds required configuration to your `~/.xinitrc` -file. +# mc | MatterLinux Configuration Manager +`mc` is a simple tool for managing desktop/window manager configurations, +it allows you to easily create configurations from your dot files and +allows you to easily install them ### Installation -To compile `xcfg` and to use it, you will need the following: +To compile `mc` and to use it, you will need the following: - gcc +- libgit2 - make -- ncurses - gettext +- libinih - doas (or sudo) After installing these dependencies, **download the latest release for a stable build**. Clone the repository only for development. -After downloading the source code, you can compile `xcfg` using the +After downloading the source code, you can compile `mc` using the `make` tool: ``` make ``` -After compiling it, you can install the binary and the locales: +After compiling it, you can install the binary, locales and the symbolic links: ``` make install ``` - -### Usage -Make sure you have access to the doas or the sudo command, then just execute -`xcfg`.