Updated README

This commit is contained in:
Dimitris Zlatanidis 2022-06-19 22:54:49 +03:00
parent b9b8672c02
commit 942438dc93

View file

@ -1,26 +1,34 @@
***********
slpkg 4.1.0
***********
.. contents:: Table of Contents:
Slpkg is a software package manager that installs, updates, and removes packages on
`Slackware <http://www.slackware.com/>`_ based systems. It automatically computes dependencies and
figures out what things should occur to install packages. Slpkg makes it easier to maintain groups
of machines without having to manually update.
Slpkg works in accordance with the standards of the organization `SlackBuilds.org <https://www.slackbuilds.org>`_
to build packages. Also uses the Slackware Linux instructions for installation,
upgrading or removing packages.
About
-----
Slpkg is a software package manager that installs, updates and removes packages on `Slackware <http://www.slackware.com/>`_ -based systems.
It automatically calculates dependencies and figures out what things need to happen to install packages.
Slpkg makes it easier to manage groups of machines without the need for manual updates.
Slpkg works in accordance with the standards of the `SlackBuilds.org <https://www.slackbuilds.org>`_ organization to build packages.
It also uses the Slackware Linux instructions for installing, upgrading or removing packages.
.. image:: https://gitlab.com/dslackw/images/raw/master/slpkg/slpkg_package.png
:target: https://gitlab.com/dslackw/slpkg
Requirements
------------
.. code-block:: bash
SQLAlchemy>=1.4.36
Install
-------
Install from the official third party `SBo repository <https://slackbuilds.org/repository/15.0/system/slpkg/>`_, or directly from the source:
Install from the official third-party `SBo repository <https://slackbuilds.org/repository/15.0/system/slpkg/>`_ or directly from source:
.. code-block:: bash
$ wget slpkg-4.1.0.tar.gz
$ tar xvf slpkg-4.1.0.tar.gz
$ cd slpkg-4.1.0
$ ./install.sh
@ -31,10 +39,47 @@ Usage
.. code-block:: bash
$ slpkg update
$ slpkg install <package_name>
$ slpkg --help
Usage: slpkg [OPTIONS] [packages]
Packaging tool that interacts with the SBo repository.
Options:
update Update the data packages.
build Build only the packages.
install Build and install the packages.
remove Remove installed packages.
search Search packages by name.
clean-logs Purge logs of dependencies.
--yes Answer Yes to all questions.
--resolve-off Turns off dependency resolving.
--reinstall Use this option if you want to upgrade.
-h, --help Show this message and exit.
-v, --version Print version and exit.
Configuration files
-------------------
.. code-block:: bash
/etc/slpkg/slpkg.json
General configuration of slpkg
/etc/slpkg/blacklist.json
Blacklist of packages
Donate
------
If you feel satisfied with this project and want to thanks me make a donation.
.. image:: https://gitlab.com/dslackw/images/raw/master/donate/paypaldonate.png
:target: https://www.paypal.me/dslackw
Copyright
---------