Amended README, corrected error in Makefile
This commit is contained in:
parent
23a78b45b3
commit
8e9f2f614f
3
Makefile
3
Makefile
|
@ -3,7 +3,7 @@ PREFIX := /usr/local
|
||||||
EXEC_PREFIX := ${PREFIX}
|
EXEC_PREFIX := ${PREFIX}
|
||||||
BINDIR := ${EXEC_PREFIX}/bin
|
BINDIR := ${EXEC_PREFIX}/bin
|
||||||
DATAROOTDIR := ${PREFIX}/share
|
DATAROOTDIR := ${PREFIX}/share
|
||||||
MANDIR := ${DATAROOTDIR}/share/man
|
MANDIR := ${DATAROOTDIR}/man
|
||||||
MAN1DIR := ${MANDIR}/man1
|
MAN1DIR := ${MANDIR}/man1
|
||||||
|
|
||||||
# Use a dateformat rather than -I flag since OSX
|
# Use a dateformat rather than -I flag since OSX
|
||||||
|
@ -46,4 +46,3 @@ clean:
|
||||||
uninstall: clean
|
uninstall: clean
|
||||||
rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz
|
rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz
|
||||||
rm -f ${DESTDIR}${BINDIR}/${BINARY}
|
rm -f ${DESTDIR}${BINDIR}/${BINARY}
|
||||||
|
|
||||||
|
|
21
README.md
21
README.md
|
@ -70,31 +70,28 @@ The installation location can be overridden at compile time, which can be very u
|
||||||
```shell
|
```shell
|
||||||
git clone https://tildegit.org/sloum/bombadillo.git
|
git clone https://tildegit.org/sloum/bombadillo.git
|
||||||
cd bombadillo
|
cd bombadillo
|
||||||
sudo make DESTDIR=/some/directory install
|
sudo make install PREFIX=/some/directory
|
||||||
```
|
```
|
||||||
|
|
||||||
There are two things to know about when using the above format:
|
There are two things to know about when using the above format:
|
||||||
1. The above would install Bombadillo to `/some/directory/usr/local/bin`, _not_ to `/some/directory`. So you will want to make sure your `$PATH` is set accordingly.
|
1. The above would install Bombadillo to `/some/directory/bin`, _not_ to `/some/directory`. So you will want to make sure your `$PATH` is set accordingly.
|
||||||
2. Using the above will install the man page to `/some/directory/usr/local/share/man`, rather than its usual location. You will want to update your `manpath` accordingly.
|
2. Using the above will install the man page to `/some/directory/share/man/man1`, rather than its usual location. You will want to update your `manpath` accordingly.
|
||||||
|
|
||||||
|
There are other overrides available - please review the [Makefile](Makefile) for more information.
|
||||||
|
|
||||||
#### Uninstall
|
#### Uninstall
|
||||||
|
|
||||||
If you used the makefile to install Bombadillo then uninstalling is very simple. From the Bombadillo source folder run:
|
If you used the Makefile to install Bombadillo then uninstalling is very simple. From the Bombadillo source folder run:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
sudo make uninstall
|
sudo make uninstall
|
||||||
```
|
```
|
||||||
|
|
||||||
If you used a custom `DESTDIR` value during install, you will need to supply it when uninstalling:
|
If you used a custom `PREFIX` value during install, you will need to supply it when uninstalling:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
sudo make DESTDIR=/some/directory uninstall
|
sudo make uninstall PREFIX=/some/directory
|
||||||
```
|
```
|
||||||
make PREFIX=~ install
|
|
||||||
```
|
|
||||||
|
|
||||||
You can then add `~/bin` to your PATH environment variable, and `~/share/man` to your manpath.
|
|
||||||
|
|
||||||
The `PREFIX` option can be used to install Bombadillo to any location different to `/usr/local`.
|
|
||||||
|
|
||||||
Uninstall will clean up any build files, remove the installed binary, and remove the man page from the system. If will _not_ remove any directories created as a part of the installation, nor will it remove any Bombadillo user configuration files.
|
Uninstall will clean up any build files, remove the installed binary, and remove the man page from the system. If will _not_ remove any directories created as a part of the installation, nor will it remove any Bombadillo user configuration files.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue