update: Add basic info to README

This commit is contained in:
ngn 2024-05-01 23:11:55 +03:00
parent bdd1ee23d8
commit 013ecfb3e7

View File

@ -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`.