mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-14 23:33:02 +01:00
Fixed INSTALL formatting (#443)
This commit is contained in:
parent
e65e3af274
commit
09e2690211
19
INSTALL.md
19
INSTALL.md
@ -1,13 +1,12 @@
|
|||||||
# Installation
|
# Installation
|
||||||
* [Dependencies](#deps)
|
* [Dependencies](#dependencies)
|
||||||
* [OS X Notes](#deps_osx)
|
* [OS X Notes](#os-x-notes)
|
||||||
* [Compiling](#compiling)
|
* [Compiling](#compiling)
|
||||||
* [Documentation](#docs)
|
* [Documentation](#documentation)
|
||||||
* [Notes](#notes)
|
* [Notes](#notes)
|
||||||
* [Compilation variables](#comp_vars)
|
* [Compilation variables](#compilation-variables)
|
||||||
* [Packaging](#packaging)
|
* [Packaging](#packaging)
|
||||||
|
|
||||||
<a name="deps" />
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
| Name | Needed by | Debian package |
|
| Name | Needed by | Debian package |
|
||||||
|------------------------------------------------------|----------------------------|---------------------|
|
|------------------------------------------------------|----------------------------|---------------------|
|
||||||
@ -22,9 +21,9 @@
|
|||||||
| [OpenALUT](http://openal.org) | SOUND NOTIFICATIONS | libalut-dev |
|
| [OpenALUT](http://openal.org) | SOUND NOTIFICATIONS | libalut-dev |
|
||||||
| [LibNotify](https://developer.gnome.org/libnotify) | DESKTOP NOTIFICATIONS | libnotify-dev |
|
| [LibNotify](https://developer.gnome.org/libnotify) | DESKTOP NOTIFICATIONS | libnotify-dev |
|
||||||
| [AsciiDoc](http://asciidoc.org/index.html) | DOCUMENTATION<sup>1</sup> | asciidoc |
|
| [AsciiDoc](http://asciidoc.org/index.html) | DOCUMENTATION<sup>1</sup> | asciidoc |
|
||||||
<sup>1</sup>: see [Documentation](#docs)
|
|
||||||
|
|
||||||
<a name="deps_osx" />
|
<sup>1</sup>: see [Documentation](#documentation)
|
||||||
|
|
||||||
#### OS X Notes
|
#### OS X Notes
|
||||||
Using [Homebrew](http://brew.sh):
|
Using [Homebrew](http://brew.sh):
|
||||||
```
|
```
|
||||||
@ -35,23 +34,19 @@ brew install libnotify
|
|||||||
|
|
||||||
You can omit `libnotify` if you intend to build without desktop notifications enabled.
|
You can omit `libnotify` if you intend to build without desktop notifications enabled.
|
||||||
|
|
||||||
<a name="Compiling">
|
|
||||||
## Compiling
|
## Compiling
|
||||||
```
|
```
|
||||||
make PREFIX="/where/to/install"
|
make PREFIX="/where/to/install"
|
||||||
sudo make install PREFIX="/where/to/install"
|
sudo make install PREFIX="/where/to/install"
|
||||||
```
|
```
|
||||||
|
|
||||||
<a name="docs" />
|
|
||||||
#### Documentation
|
#### Documentation
|
||||||
Run `make doc` in the build directory after editing the asciidoc files to regenerate the manpages.<br />
|
Run `make doc` in the build directory after editing the asciidoc files to regenerate the manpages.<br />
|
||||||
**NOTE FOR DEVELOPERS**: asciidoc files and generated manpages will need to be commited together.<br />
|
**NOTE FOR DEVELOPERS**: asciidoc files and generated manpages will need to be commited together.<br />
|
||||||
**NOTE FOR EVERYONE**: [asciidoc](http://asciidoc.org/index.html) (and this step) is only required for regenerating manpages when you modify them.
|
**NOTE FOR EVERYONE**: [asciidoc](http://asciidoc.org/index.html) (and this step) is only required for regenerating manpages when you modify them.
|
||||||
|
|
||||||
<a name="notes" />
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
<a name="comp_vars" />
|
|
||||||
#### Compilation variables
|
#### Compilation variables
|
||||||
* You can add specific flags to the Makefile with `USER_CFLAGS=""` and/or `USER_LDFLAGS=""`
|
* You can add specific flags to the Makefile with `USER_CFLAGS=""` and/or `USER_LDFLAGS=""`
|
||||||
* You can pass your own flags to the Makefile with `CFLAGS=""` and/or `LDFLAGS=""` (this will supersede the default ones)
|
* You can pass your own flags to the Makefile with `CFLAGS=""` and/or `LDFLAGS=""` (this will supersede the default ones)
|
||||||
@ -61,10 +56,8 @@ Run `make doc` in the build directory after editing the asciidoc files to regene
|
|||||||
* `DISABLE_SOUND_NOTIFY=1` → build toxic without sound notifications support
|
* `DISABLE_SOUND_NOTIFY=1` → build toxic without sound notifications support
|
||||||
* `DISABLE_DESKTOP_NOTIFY=1` → build toxic without desktop notifications support
|
* `DISABLE_DESKTOP_NOTIFY=1` → build toxic without desktop notifications support
|
||||||
|
|
||||||
<a name="packaging" />
|
|
||||||
#### Packaging
|
#### Packaging
|
||||||
* For packaging purpose, you can use `DESTDIR=""` to specify a directory where to store installed files
|
* For packaging purpose, you can use `DESTDIR=""` to specify a directory where to store installed files
|
||||||
* `DESTDIR=""` can be used in addition to `PREFIX=""`:
|
* `DESTDIR=""` can be used in addition to `PREFIX=""`:
|
||||||
* `DESTDIR=""` is meant to specify a directory where to store installed files (ex: "/tmp/build/pkg")
|
* `DESTDIR=""` is meant to specify a directory where to store installed files (ex: "/tmp/build/pkg")
|
||||||
* `PREFIX=""` is meant to specify a prefix directory for binaries and data files (ex: "/usr/local")
|
* `PREFIX=""` is meant to specify a prefix directory for binaries and data files (ex: "/usr/local")
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user