From 034eb81d641d8a5fa9fbe63da1b95c278de468ba Mon Sep 17 00:00:00 2001 From: Alz Date: Wed, 13 Mar 2019 11:22:30 +0100 Subject: [PATCH] Refactored README and INSTALL into README.rst --- INSTALL | 46 ------------------------------ README => README.rst | 66 ++++++++++++++++++++++++++++++++++---------- 2 files changed, 51 insertions(+), 61 deletions(-) delete mode 100644 INSTALL rename README => README.rst (54%) diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 570ee46..0000000 --- a/INSTALL +++ /dev/null @@ -1,46 +0,0 @@ -# -# INSTALL - Instructions to install the BANDIT on the HOST system -# -# Copyright (C) 2015-2019 Angel Linares Zapater -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License, version 2, as -# published by the Free Software Foundation. See the COPYING file. -# -# This program is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# - -Installing BANDIT on the HOST system -==================================== - -In the following commands replace with the latest version available. - -Download the latest released version of BANDIT from ftp://phyglos.org/bandit -$ wget ftp://phyglos.org/bandit/bandit-.tar.gz -$ tar xvf bandit-.tar.gz - -Optionally, rename the BANDIT directory when needed: -$ mv bandit- bandit - -Alternatively, clone from the github.com repository to get the development master branch. -$ git clone https://github.com/phyglos/bandit - -As root, move the file to /opt and change into that directory -# mv bandit /opt -# cd /opt -# chown -R root.root /opt/bandit - -Initialize the HOST environment for BANDIT from the bandit home directory: -# cd bandit -# source bandit.env - -Bandit should work now in the HOST. Test with: -# bandit --version - -To get help about all bandit options, issue: -# bandit --help - - -See https://docs.phyglos.org/bandit for more information. - diff --git a/README b/README.rst similarity index 54% rename from README rename to README.rst index 9c48141..c082b1a 100644 --- a/README +++ b/README.rst @@ -1,18 +1,17 @@ -# -# README - General description of the contents of the tarball -# -# Copyright (C) 2015-2019 Angel Linares Zapater -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License, version 2, as -# published by the Free Software Foundation. See the COPYING file. -# -# This program is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# + README - General description of the BANDIT toolkit + + Copyright (C) 2015-2019 Angel Linares Zapater + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License, version 2, as + published by the Free Software Foundation. See the COPYING file. + + This program is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Getting started =============== + The Build AND Install Toolkit, or the BANDIT, is a software toolkit used to build and install new software functionality into a GNU/Linux system. @@ -35,22 +34,59 @@ When BANDIT is installed in a supported Linux distribution other than phyglos, like Debian or Fedora, it is normally used to raise a new phy system in a free partition on any internal or external disk (or even as a container image). - How to use ========== -The INSTALL file describes how to install BANDIT in the HOST system. +*In the following commands replace "latest" with the desired version.* + +Download the latest released version of BANDIT from ftp://phyglos.org/bandit and, +optionally, rename the BANDIT directory when needed: + + $ wget ftp://phyglos.org/bandit/bandit-latest.tar.gz + + $ tar xvf bandit-latest.tar.gz + + $ mv bandit-latest bandit + +Alternatively, clone from Github.com the repository to get the development master branch. + + $ git clone https://github.com/phyglos/bandit + +As root, move the folder to /opt and change into that directory, and ensure that the +root permissions are set: + + # mv bandit /opt + + # cd /opt + + # chown -R root.root /opt/bandit + +Initialize the HOST environment for BANDIT from the bandit home directory: + + # cd bandit + + # source bandit.env + +Bandit should work now in the HOST. Test with: + + # bandit --version + +or, to get help about all bandit options, issue: + + # bandit --help Status ====== + The BANDIT is in STABLE status. The toolkit is capable of building and installing a new phy system from a HOST system running Debian, Fedora or phyglos. The BANDIT is able to manage software bundles on a phy system. - More information ================ + The COPYING file contains the GNU License for this software. + The RELEASE file describes the main changes in this release. See https://docs.phyglos.org/bandit for more information.