docs: add readme improvements (#35)

* docs: screenshot and build instruction in readme

* fix: screenshot of english version
This commit is contained in:
Michael Chernigin 2023-05-29 11:27:09 +04:00 committed by GitHub
parent 97f3f0aef8
commit 1a6bf7bdbd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 16 deletions

View File

@ -1,22 +1,25 @@
# Building and installing on ALT-Linux
# Build dependencies
On ALT-Linux distributions all build dependencies can be installed with following command:
All build dependencies can be installed with following command:
```
apt-get install cmake rpm-macros-cmake cmake-modules gcc-c++ qt5-base-devel qt5-declarative-devel qt5-tools-devel
libsmbclient-devel libsmbclient samba-devel libldap-devel libsasl2-devel libsmbclient-devel libuuid-devel glib2-devel
libpcre-devel libkrb5-devel qt5-base-common doxygen libxerces-c-devel xsd boost-devel-headers desktop-file-utils
ImageMagick-tools libqt-mvvm-devel xorg-xvfb xvfb-run
apt-get install cmake rpm-macros-cmake cmake-modules gcc-c++ qt5-base-devel qt5-declarative-devel qt5-tools-devel libsmbclient-devel libsmbclient samba-devel libldap-devel libsasl2-devel libsmbclient-devel libuuid-devel glib2-devel libpcre-devel libkrb5-devel qt5-base-common doxygen libxerces-c-devel xsd boost-devel-headers desktop-file-utils ImageMagick-tools libqt-mvvm-devel xorg-xvfb xvfb-run
```
# Building with CMake and Make
After that GPUI can be built like so:
```
mkdir -p build
cmake -B build -DGPUI_BUILD_TESTS=OFF .
cd build && make -j `nproc`
cd build
make -j `nproc`
```
## ADMX
To use GPUI with ADMX policies, you need to also install them like so:
```
apt-get install admx-msi-setup
admx-msi-setup
```

View File

@ -1,9 +1,27 @@
## GPUI
![build workflow](https://github.com/august-alt/gpui/actions/workflows/main.yml/badge.svg)
![tests workflow](https://github.com/august-alt/gpui/actions/workflows/test.yml/badge.svg)
GPUI - is an open source utility for group policy management.
# GPUI
## Installation and Usage
GPUI — is an open source utility for group policy management on ALT-Linux.
Refer to the included INSTALL.md file for directions of how to compile, install, and
use the GPUI.
![Screenshot](https://github.com/mchernigin/gpui/assets/59616661/951b3715-96f0-4c8f-b044-33ab4b94a75f)
## Building and installation
For building and installation instructions refer to [INSTALL.md](INSTALL.md).
## Basic usage
```
Usage: gpui-main [options]
Options:
-p <path> The full path of policy to edit.
-b <path> The full path of policy bundle to load.
-h, --help Displays help on commandline options.
-n <name> This options left for compatibility with ADMC. Currently it
does nothing.
-v, --version Displays version information.
```