[pybliographer] Update formatting
- From: Germán Poo-Caamaño <gpoo src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pybliographer] Update formatting
- Date: Fri, 17 Aug 2018 15:03:27 +0000 (UTC)
commit fc38237f4809ab83bc5d234ad3cf58efdb12a4fc
Author: Germán Poo-Caamaño <gpoo gnome org>
Date: Fri Aug 17 12:02:39 2018 -0300
Update formatting
README.md | 48 +++++++++++++++++++++++++-----------------------
1 file changed, 25 insertions(+), 23 deletions(-)
---
diff --git a/README.md b/README.md
index 6fd7971..7c3252d 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,58 @@
--*- text -*-
-=================================================================
+# ![pybliographer-logo] Pybliographer
Pybliographer provides a framework for working with bibliographic
databases.
-For more information, please consult the documentation at:
+This software is licensed under the [GPLv2][license].
- http://pybliographer.org/
+For more information, please consult the documentation at the [webiste][pybliographer-website].
-=================================================================
-
-* Requirements
- ------------
+## Requirements
Before installing pybliographer, please install:
-
- - GNU Recode (v. 3.5)
- - python-bibtex (also available from http://pybliographer.org/)
- - Gnome 2.x and gnome-python 2.x
+* GNU Recode (v. 3.5)
+* python-bibtex (also available at the [website][pybliographer-website])
+* Gnome 2.x and gnome-python 2.x
-* Installation
- ------------
+## Installation
Basically, it should be a matter of:
+```
./configure && make
su
make install
+```
You can then run several programs :
- - pybliographic : the graphical interface
- - pybliographer : the text-based interface and scripting language
- - pybcheck, pybconvert, pybformat, ... : several useful tools
+* pybliographic : the graphical interface
+* pybliographer : the text-based interface and scripting language
+* pybcheck, pybconvert, pybformat, ... : several useful tools
+
+For more configuration options, have a look at the output of `./configure --help`.
-For more configuration options, have a look at the output of ./configure --help
-* Troubleshooting
- ---------------
+# Troubleshooting
If the configure script reports the following errors:
- ** "error in python modules dependencies: No module named ..."
+* *"error in python modules dependencies: No module named ..."*
This means that a required module is not installed. Unfortunately,
depending on your distribution, the actual package to install can
be named differently. Check on the help pages of your distribution.
- ** "broken recode version"
+* *"broken recode version"*
Your recode package does not behave properly. Consult
- http://pybliographer.org/RecodeHelp for more information.
+ [recode help][recode-help] for more information.
+
+
+[license]: COPYING
+[pybliographer-website]: https://pybliographer.org/
+[recode-help]: http://pybliographer.org/RecodeHelp
+[pybliographer-logo]: data/icons/48x48/pybliographic.png
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]