README.md

   1 # vpm - An XBPS package management helper for VoidLinux
   2
   3 Copyright (c) 2016: Armin Jenewein <vpm@m2m.pm>
   4
   5
   6 This program is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 # License
  20 vpm is released under the terms of the GNU General Public License,
  21 Version 3. See the LICENSE file for further information.
  22
  23 # About (What is vpm?)
  24 vpm is a simple to use, daily-driver enhancement to the awesome XBPS (X Binary Package System), initially designed as a helper tool for use with VoidLinux. Feel free to think "Void Package Management" or something if it helps you remember its name, but please note that it's NOT a "package manager" in the nitpickers understanding of the word - especially vpm shouldn't be confused with XBPS - vpm is just an addon helper tool for XBPS to make your life easier. That's it.
  25
  26 # Screenshots
  27
  28 Screenshot of a (not so) recent (anymore) vpm release:
  29
  30 ![alt tag](https://raw.githubusercontent.com/netzverweigerer/vpm/master/screenshots/vpm.png)
  31
  32 Screenshot of vpm in full effect:
  33
  34 ![alt tag](https://raw.githubusercontent.com/netzverweigerer/vpm/master/screenshots/vpm2.png)
  35
  36 # Motivation to write vpm
  37 I initially found XBPS to have a steep learning-curve, so I wanted to ease the life of new VoidLinux users, and XBPS users in general. Please don't feel afraid to look up the corresponding XBPS commands it translates to, or use vpm --show-translations so you even see the translations already when using vpm help. It has been said that vpm will ease the transition from Debian's APT, and some other user-friendly repository/package-managers.
  38
  39 # ZOMG! PONIES!!111
  40 Rainbows and unicorns, indeed. If you like colorized output, please see the --color=true option, too! All vpm options try to have human readable and easy to remember syntax, no --long-option-with-multiple-complex-words, no need to even prefix arguments with --, vpm just tries to do its best it can to understand the user (there are some command-line-switches, though, see vpm help).
  41
  42 # Dependencies
  43 vpm requires BASH, the Bourne Again SHell, which should be installed by default on a new VoidLinux system. You also will need git to obtain a clone of the vpm GitHub repository (see "Installation" section, below).
  44
  45 # Installation
  46 Installing vpm should be as easy as following the simple following steps:
  47
  48 1. Install git via xbps-install
  49
  50         $ xbps-install -S git
  51
  52 2. Clone vpm repository
  53
  54         $ git clone git@github.com:netzverweigerer/vpm.git
  55
  56 I'm not covering how to put vpm into a place that is in your $PATH as I can't give general UNIX administration support in this README.
  57
  58 # Author
  59 vpm was written by Armin Jenewein (GitHub: @netzverweigerer) <vpm@m2m.pm>
  60
  61
  62