Skip to content
README.md 1.17 KiB
Newer Older
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
# Tour Application
This application provides for the users a possibility to create bootstrap-tours for every page they want.

* Extension Page: http://extensions.xwiki.org/xwiki/bin/view/Extension/Tour+Application.
* Bug Tracker: http://jira.xwiki.org/browse/TOUR.
* License: LGPL 2.1+.

Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
## Translations
You can contribute to translate this application in various languages on http://l10n.xwiki.org/xwiki/bin/view/Contrib/TourApplication.

You don't need to have technical knowledge to contribute to the translations, feel free to do it!

Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
## Developers

### How to build
```
mvn clean install -Pquality --settings maven-settings.xml
```

Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
### Commit new translations
To get the translations done on the [l10n.xwiki.org](http://l10n.xwiki.org/xwiki/bin/view/Contrib/TourApplication) website and commit them into the application, you need to execute the `get-translations.sh` command:

```
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
## Get the translations
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
./get-translations.sh
## Look at the new translations
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
git status
## Add changes (example)
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
git add src/main/resources/TourCode/TourTranslations.fr.xml
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
git commit
## Push them (or make a pull request)
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
git push origin master
Guillaume Delhumeau's avatar
Guillaume Delhumeau committed
It should be done before every release.