weblate/docs/quick.rst
2013-02-28 09:42:11 +01:00

64 lines
2.1 KiB
ReStructuredText

Quick setup guide
=================
.. note::
This is just a quick guide for installing and starting to use Weblate for
testing purposes. Please check :ref:`install` for more real world setup
instructions.
Installing from sources
-----------------------
#. Install all required dependencies, see :ref:`requirements`.
#. Grab Weblate sources (either using Git or download a tarball) and unpack
them.
#. Copy :file:`weblate/settings_example.py` to :file:`weblate/settings.py` and
adjust it to match your setup. You will at least need to configure database
connection (possibly adding user and creating the database). Check
:ref:`config` for Weblate specific configuration options.
#. Build Django tables and initial data:
.. code-block:: sh
./manage.py syncdb
./manage.py migrate
./scripts/generate-locales # If you are using Git checkout
#. Configure webserver to serve Weblate, see :ref:`server`.
Using prebuilt appliance
------------------------
#. Download the appliance and start it. You need to choose format depending on
your target environment.
#. Everything should be set up immediately after boot, though you will want
to adjust some settings to improve security, see :ref:`appliance`.
Adding translation
------------------
#. Open admin interface (http://example.org/admin/) and create project you
want to translate. See :ref:`project` for more details.
All you need to specify here is project name and it's website.
#. Create subproject which is the real resource for translating - it points to
Git repository and selects which files to translate. See :ref:`subproject`
for more details.
The important fields here being subproject name, Git repository address and
mask for finding translatable files. Weblate supports wide range of formats
including Gettext PO files, Android resource strings, OS X string properties,
Java properties or Qt Linguist files, see :ref:`formats` for more details.
#. Once above is completed (it can be lengthy process depending on size of
your Git repository and number of messages to translate), you can start
translating.