~brandelune/omegat-as-a-book

Project page | Mailing list | Git repository | Trackers | Sessions Documentation


#Building OmegaT from the command line

I'm making here a summary of 3 build instructions: to run OmegaT, to install OmegaT, and to create the javadoc developer documentation.

This summary assumes that you have git cloned a working OmegaT repository, either this one or the official one.

#Everything is in the documentation

Everything you need to know is documented in omegat/docs_devel/README.txt.

#If you want to know a bit more

You'll find the following files in the omegat/ directory:

  • LICENSE (the OmegaT GPL3 licence text)
  • Plugins.properties (a list of OmegaT provided plugins)
  • README.md (the default OmegaT readme file)
  • build/ (contains all the built files)
  • build.gradle (contains the information to execute the various build tasks)
  • config/ (contains a file that's used to check the coding style)
  • doc_src/ (contains the DocBook manual sources)
  • docs/ (contains the HTML manuals)
  • docs_devel/ (contains various documents for developers)
  • gradle/ (contains various gradle related files)
  • gradlew (the gradle startup script for unix/macOS)
  • gradlew.bat (the gradle startup script for Windows)
  • images/ (contains various images for the OmegaT logo/icons)
  • lib/ (contains various libraries used by OmegaT and their licenses)
  • local.properties.example (an example of local.properties file)
  • release/ (contains various release related files)
  • scripts/ (contains the OmegaT scripts and their localization files)
  • settings.gradle (a gradle settings file)
  • src/ (contains the source code for OmegaT)
  • test/ (contains various test related files)
  • test-integration/ (contains various test related files)
#The build process

As written in omegat/docs_devel/README.txt, you only need to run gradlew if you're on Linux/macOS, etc. or gradlew.bat if you're on Windows.

From the omegat/ directory:

$ ./gradlew task will output a list of things you can do, among which you'll find the following three tasks.

  • $ ./gradlew run will build and run OmegaT. If you want to test your modifications, that's probably the easiest way to do that.

  • $ ./gradlew installDist puts an executable OmegaT distribution inside build/install/OmegaT/. You can use the OmegaT.jar file found there to run OmegaT.

  • $ ./gradlew javadoc puts the whole javadoc set inside build/docs/javadoc/.

#Building and/or running OmegaT from an IDE

Each IDE has Run or Build menu items. If the project is properly set, using them should be enough to produce similar results.


Project page | Mailing list | Git repository | Trackers | Sessions Documentation

About this wiki

commit db6cb0c45a3c452840adf37179e55a92f83e5aee
Author: Nick Pizzigati <npizzigati@gmail.com>
Date:   2022-01-30T09:27:46-06:00

Update Nick's intro
Clone this wiki
https://git.sr.ht/~brandelune/omegat-as-a-book (read-only)
git@git.sr.ht:~brandelune/omegat-as-a-book (read/write)