aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 19 insertions, 22 deletions
diff --git a/README.md b/README.md
index 100062c..8516a5f 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,8 @@ library for writing multilingual systems.
## Requeriments
-The GNU C library. If you're using GNU/Linux, FreeBSD or OSX you should already
-have it.
+The GNU C library. If you're using GNU/Linux, FreeBSD or OSX you probably
+already have it.
## Installation
@@ -18,6 +18,9 @@ go get github.com/gosexy/gettext
## Usage
+This is an example program showing the `BindTextdomain`, `Textdomain` and
+`SetLocale` bindings:
+
```go
package main
@@ -39,27 +42,27 @@ func main() {
}
```
-You can use `os.Setenv` to set the `LANGUAGE` environment variable or set it
-on a terminal:
+Set the `LANGUAGE` env to the name of the language you want to use in your
+program:
```sh
export LANGUAGE="es_MX.utf8"
-./gettext-program
+./myapp
```
-Note that `xgettext` does not officially support Go syntax yet, however, you
-can generate a valid `.pot` file by forcing `xgettest` to use the C++
-syntax:
+You can use the `xgettext` command to extract strings to be translated from a
+Go program:
-```sh
-xgettext -d example -s gettext_test.go -o example.pot -L c++ -i \
---keyword=NGettext:1,2 --keyword=Gettext
+```
+go get github.com/gosexy/gettext/go-xgettext
+
+xgettext -o outfile.pot --keyword=Gettext --keyword-plural=NGettext -i infile.go
```
This will generate a `example.pot` file.
-After translating the `.pot` file, you must generate `.po` and `.mo` files and
-remember to set the UTF-8 charset.
+After actually translating the `.pot` file, you'll have to generate `.po` and
+`.mo` files with `msginit` and `msgfmt`:
```sh
msginit -l es_MX -o example.po -i example.pot
@@ -74,21 +77,15 @@ mv example.mo examples/es_MX.utf8/LC_MESSAGES/example.mo
## Documentation
-You can read `gosexy/gettext` documentation from a terminal
-
-```sh
-go doc github.com/gosexy/gettext
-```
-
-Or you can [browse it](http://godoc.org/github.com/gosexy/gettext) online.
+Check out the API documentation [godoc.org/github.com/gosexy/gettext)](http://godoc.org/github.com/gosexy/gettext).
-The original gettext documentation could be very useful as well:
+The original gettext documentation:
```sh
man 3 gettext
```
-Here's another [good tutorial][2] on using gettext.
+And here's a [good tutorial][2] on using gettext.
[1]: http://www.gnu.org/software/gettext/
[2]: http://oriya.sarovar.org/docs/gettext_single.html