Skip to content

Commit

Permalink
Minor reformatting for markdown, add travis build status
Browse files Browse the repository at this point in the history
  • Loading branch information
toddy15 committed Jun 16, 2018
1 parent 6062d49 commit da889fa
Showing 1 changed file with 49 additions and 41 deletions.
90 changes: 49 additions & 41 deletions README.md
@@ -1,5 +1,6 @@
Introduction to Po4a
====================
# Introduction to Po4a

[![Build Status](https://travis-ci.org/mquinson/po4a.svg?branch=master)](https://travis-ci.org/mquinson/po4a)

The po4a (PO for anything) project goal is to ease translations (and
more interestingly, the maintenance of translations) using gettext
Expand All @@ -26,82 +27,89 @@ module for the following formats:
- xml: generic XML documents (see also docbook).
- yaml: YAML documents.

INSTALLATION
# Installation

To install this module type the following:

```
perl Build.PL
./Build
./Build install
```


USE WITHOUT INSTALLATION
# Use without installation

If you want to use a version without installing it (e.g. directly from
the git tree), use the PERLLIB environment variable as such:

```
PERLLIB=~/git-checkouts/po4a/lib ~/git-checkouts/po4a/po4a-gettextize [usual args]
```

# Po4a dependencies

* Locale::gettext (v1.01)

This module being itself internationalized, it needs the Locale::gettext
library to translate its own messages.
If it is not present, then po4a's messages won't be translated, but
po4a will remain fully functional.

PO4A DEPENDENCIES
* Text::WrapI18N

Locale::gettext (v1.01):
This module being itself internationalized, it needs the Locale::gettext
library to translate its own messages.
If it is not present, then po4a's messages won't be translated, but
po4a will remain fully functional.
This module is used to format po4a's warnings and error messages. It
permits to wrap long error messages without splitting words.
If it is not present, the formatting of messages will be different,
but po4a will remain fully functional.

Text::WrapI18N:
This module is used to format po4a's warnings and error messages. It
permits to wrap long error messages without splitting words.
If it is not present, the formatting of messages will be different,
but po4a will remain fully functional.
* Term::ReadKey

Term::ReadKey:
This module is used to retrieve the terminal's line width. It is not
used if Text::WrapI18N is not available.
If it is not present, the line width can be specified with the COLUMN
environment variable.
This module is used to retrieve the terminal's line width. It is not
used if Text::WrapI18N is not available.
If it is not present, the line width can be specified with the COLUMN
environment variable.


SGML MODULE SPECIFIC DEPENDENCIES
## SGML module specific dependencies

SGMLS (1.03ii):
This is a set of Perl5 routines for processing the output from the onsgmls
SGML parser.
* SGMLS (1.03ii)

opensp (1.5.2): OpenJade group's SGML parsing tools
This is the SGML parser we use.
This is a set of Perl5 routines for processing the output from the onsgmls
SGML parser.

* opensp (1.5.2) OpenJade group's SGML parsing tools

TEXT MODULE SPECIFIC DEPENDENCIES
This is the SGML parser we use.

Unicode::GCString:
This module is used to compute text width; it is needed by AsciiDoc to
determine two line titles in encodings different from ASCII.
https://github.com/hatukanezumi/Unicode-LineBreak
## Text module specific dependencies

* Unicode::GCString

YAML MODULE SPECIFIC DEPENDENCIES
This module is used to compute text width; it is needed by AsciiDoc to
determine two line titles in encodings different from ASCII.
https://github.com/hatukanezumi/Unicode-LineBreak

YAML::Tiny:
This module is used to parse and serialize the YAML file.

## YAML module specific dependencies

PROJECT HOSTING
* YAML::Tiny

This module is used to parse and serialize the YAML file.

# Project hosting

- Webpage: https://po4a.org
- Source code: https://github.com/mquinson/po4a
- Bug tracker: https://github.com/mquinson/po4a/issues
- Source of the web pages: https://github.com/mquinson/po4a-website


COPYRIGHT AND LICENSE
# Copyright and license

This program is free software; you may redistribute it and/or modify it
under the terms of GPL (see COPYING file).

Copyright (C) 2002-2O18 by SPI, inc.
Copyright © 2002-2O18 by SPI, inc.

Authors:
Denis Barbier <barbier@linuxfr.org>
Martin Quinson (mquinson#debian.org)
- Denis Barbier <barbier@linuxfr.org>
- Martin Quinson (mquinson#debian.org)

0 comments on commit da889fa

Please sign in to comment.