Update the README

This commit is contained in:
Pierre Pronchery 2020-11-03 06:57:21 +01:00
parent c46844f84c
commit ac95d85dc1

View File

@ -9,8 +9,7 @@ Browser is a file manager and image browser.
It can be extended through plug-ins, which are then displayed in the left pane
of the file management windows.
Browser is part of the DeforaOS Project, and distributed under the terms of the
BSD License (2-clause).
Browser is part of the DeforaOS Project, found at https://www.defora.org/.
Compiling Browser
@ -20,8 +19,10 @@ Browser depends on the following components:
* Gtk+ 2 or 3
* DeforaOS libDesktop
* DocBook-XSL (for the manual pages)
* GTK-Doc (for the API documentation)
* an implementation of `make`
* gettext (libintl) for translations
* DocBook-XSL for the manual pages
* GTK-Doc for the API documentation
With GCC, this should then be enough to compile and install Browser:
@ -46,3 +47,9 @@ DocBook-XSL to be installed for conversion to the HTML or man file format.
Likewise, the API reference for Browser (plug-ins) is available in the
`doc/gtkdoc` folder, and is generated using gtk-doc.
Distributing Browser
--------------------
DeforaOS Browser is subject to the terms of the 2-clause BSD license. Please
see the `COPYING` file for more information.