Program for sending SMS over the Internet
Java Shell Other

README.md

Esmska

Esmska is a program for sending SMS over the Internet using one of many supported gateways.


No Maintenance Intended

Esmska is not maintained aymore!

I do no longer have time to developer nor maintain this project. The only patches I accept are gateway updates. Apart from that, please fork my repository and develop the patches in your space. If your version becomes significantly improved over this original version, please contact me and I'll happily forward visitors to your program.


Program links

Program files

README.md       - This file.
gateways/       - Script files for using operator gateways.
include/        - Files included in the binary distribution.
installjammer/  - Configuration files for InstallJammer.
launch4j/       - Configuration files for Launch4J.
lib/            - Program compilation and runtime libraries.
nbproject/      - Project files for the NetBeans IDE.
po/             - Localization files.
resources/      - Various resource files.
scripts/        - Various scripts for managing building process.
src/            - Program sources.
packaging/      - Files related to Linux packaging and OpenSUSE Build Service.

Program license is GNU AGPL v3+, see include/license/ for more details.

Project root directory can be opened by NetBeans IDE as its project.

Getting program

Check out Esmska repository:

$ git clone git://github.com/kparal/esmska.git

By default you'll see the main development branch ('master'). You can switch to any other branch or tagged version by using:

$ git branch               # lists all branches
$ git tag                  # lists all tags
$ git checkout BRANCH|TAG

Compilation requirements

  • Java 6 JDK (Sun tested)
  • Ant
    • in Ubuntu packaged as ant

Provided by lib/ directory:

  • CopyLibs
    • included in NetBeans IDE 7.0
  • Mac UI
    • included in Apple Java
    • optional: see compiling section for information how to build without Mac OS support
  • AppBundler
  • all runtime requirements

Runtime requirements

  • Java 6 JRE (Sun and OpenJDK tested)

Provided by lib/ directory:

If you wish to use other libraries than the ones provided in lib/ directory (e.g. package maintainers may want this) you can specify classpaths to individual libraries in file lib/nblibraries.properties. Variables ending with .classpath will be of interest to you.

Compiling program

In sources root directory (where build.xml is located) run this command:

$ ant clean jar

If you want to build the program without Mac OS support (for example Linux package maintainers not willing to use Apple library), use command:

$ ant -DnoMac=true clean jar

All the sources should be compiled in the build/ directory. In the dist/ directory the resulting esmska.jar should be created, together with all needed libraries, available gateways and some additional files copied from include/ directory.

Running program

After compiling you can run Esmska by command:

$ ./dist/esmska.sh

or

$ ant run

from the sources root directory.

Packaging program

You can run command:

$ ./scripts/create-package VERSION

to obtain binary program packages (multiplatform and Windows) inside the program root directory.

Mac packages can be created only on Mac OS by running this command:

$ ant -f build-mac.xml

When creating custom packages it may be good to note that the only important files for the program are esmska.jar, esmska.conf, lib/ and gateways/ directory. All other files are intended only for the end-user and the program does not use them.

Package maintainer should be interested in resources/ directory. It contains many files useful for making packages. Especially an always up-to-date esmska.desktop file should be used, because it contains localized menu item translations.

You should also see the esmska.conf file, which is a system-wide configuration file. You can set some default configuration there (like turning off update notification for example, when you are distributing program through linux repositories).

Working with translations

Program uses src/esmska/resources/l10n*.properties files for localization. There are gettext files in the po/ directory for simplifying user contributions. By running command:

$ ./scripts/update-translations

a new po/esmska.pot template is generated, all PO message catalogs are updated and localized properties files are generated from them.