Giter VIP home page Giter VIP logo

unitex-packaging-windows's Introduction

Unitex/GramLab Setup Installer for Windows Build Status

Unitex/GramLab is an open source, cross-platform, multilingual, lexicon- and grammar-based corpus processing suite.

This NSIS script is used to create the Unitex/GramLab setup installers for Windows (32-bit and 64-bit) on POSIX compliant systems. NSIS (Nullsoft Scriptable Install System) is a scripting tool to create Windows installers. Installers are generated by using the makensis program to compile a NSIS script (.nsi) into an executable. NSIS is released under an open source license and is completely free for any use. For more details, please visit the nsis website.

Script dependencies

  • NSIS distribution (version >= 3.0). Type makensis -VERSION to test your version.
    If you need an update version, please visit nsis
  • GNU awk (version >= 3.0) Type awk --version to test your version.
    If you need an update version, please visit http://www.gnu.org/software/gawk/

Script compilation

Usage:
makensis -DVER_MAJOR=# -DVER_MINOR=# -DVER_REVISION=# [OPTIONS] unitex.nsi

For a full list of compiler flags supported by this program, just type makensis unitex.nsi [return] at the command line. For a full list of parameters and further information about the makensis command, type makensis [return].

Example

Before beginning, please remember that this program only compiles on POSIX compliant systems (i.e. not on Windows). This is mainly due to the use of the !system command thats runs with /bin/sh. There aren't any plans for a Windows support at the moment.

  1. Download the Unitex/GramLab package source containing the Unitex/GramLab source distribution.
  2. Unzip all files in a folder at one time.
  3. Take notice of the main folder name:
    Unitex-GramLab-${VER_MAJOR}.${VER_MINOR}${VER_SUFFIX}, e.g.
    Unitex-GramLab-3.1 VER_MAJOR=3 VER_MINOR=1 VER_SUFFIX=""
    Unitex-GramLab-3.1rc VER_MAJOR=3 VER_MINOR=1 VER_SUFFIX="rc"
  4. Take notice of the parent folder name, i.e. the directory where the
    Unitex/GramLab distribution directory is placed. This directory will be your ${INPUT_BASEDIR} location.
  5. Create the final setup installer typing:
    makensis -DANONYMOUS_BUILD -DINPUT_BASEDIR=path -DVER_MAJOR=number -DVER_MINOR=number -DVER_SUFFIX=suffix unitex.nsi
    For example:
    makensis -DANONYMOUS_BUILD -DINPUT_BASEDIR=. -DVER_MAJOR=3 -DVER_MINOR=1 -DVER_SUFFIX=beta unitex.nsi
    This will create an executable named: Unitex-GramLab-3.1beta_anonymous_win32-setup.exe

Non-anonymous builds are further documented here

Setup installer command line parameters

The produced Unitex/GramLab Windows setup installer accepts several optional command line parameters. Some common options are:

Option Description
/AllUsers Set default to a per-machine installation
/CurrentUser Set default to a per-user installation.
/D C:\path\without quotes\ Sets the default installation directory. It mustbe the last parameter and must not contain any quotes. Only absolute paths are supported
/NCRC The installer will not perform a Cyclic Redundancy Check (CRC) on itself before allowing an install
/S Runs the installer or the uninstaller silently

Setup installer features

  • User selection of Unitex/GramLab installation components (Core Components,
    Visual IDEs, Linguistic Resources, Source Code, User Manual, Start Menu
    and Desktop Shortcuts).
  • Several installation types : Full, Standard, Minimal and Custom.
  • Automatic JRE (Java Runtime Edition) detection. If the JRE isn't installed,
    a dialog allows the user to choose between a manual or automatic install.
  • System language detection to preselect Linguistic Resources to install.
  • Same, older or newer version detection.
  • Application, Manual, and Web links shortcuts.
  • Admin or user installation mode support.
  • Mixed-mode installer that can both be installed per-machine or per-user.
  • Silent mode support for batch installs.
  • Uninstall support.
  • Support for a web installation mode.
  • Check for updates.
  • User interface i18n.

Support

Support questions can be posted in the community support forum. Please feel free to submit any suggestions or requests for new features too. Some general advice about asking technical support questions can be found here.

Reporting Bugs

See the Bug Reporting Guide for information on how to report bugs.

Governance Model

Unitex/GramLab project decision-making is based on a community meritocratic process, anyone with an interest in it can join the community, contribute to the project design and participate in decisions. The Unitex/GramLab Governance Model describes how this participation takes place and how to set about earning merit within the project community.

Spelling

Unitex/GramLab is spelled with capitals "U" "G" and "L", and with everything else in lower case. Excepting the forward slash, do not put a space or any character between words. Only when the forward slash is not allowed, you can simply write “UnitexGramLab”.

It's common to refer to the Unitex/GramLab Core as "Unitex", and to the Unitex Project-oriented IDE as "GramLab". If you are mentioning the distribution suite (Core, IDE, Linguistic Resources and others bundled tools) always use "Unitex/GramLab".

Contributing

We welcome everyone to contribute to improve this project. Below are some of the things that you can do to contribute:

License

This program is licensed under the GNU Lesser General Public License version 2.1. Contact [email protected] for further inquiries.

--

Copyright (C) 2021 Université Paris-Est Marne-la-Vallée

unitex-packaging-windows's People

Contributors

martinec avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

hidekithiago

unitex-packaging-windows's Issues

Add repository to Travis CI

Add the repository to Travis CI.

.travis.yml

language: bash
before_install:
  - sudo apt-get -qq update
  - sudo apt-get install -y nsis nsis-common 
install:
 - wget http://unitex.univ-mlv.fr/releases/latest-rc/source/Unitex-GramLab-3.1rc-source-distribution.zip && Unitex-GramLab-3.1rc-source-distribution.zip
script:
  - makensis -DANONYMOUS_BUILD -DVER_MAJOR=3 -DVER_MINOR=1 -DVER_SUFFIX=rc -DDEBUG_MODE -DINPUT_BASEDIR=. unitex.nsi
notifications:
  email: false
sudo: required

uninstaller in case 2 versions are installed

I used the Windows installers to install the current stable version (Unitex/GramLab 3.1) and Unitex/GramLab 3.2alpha (Rev. 56) on the same computer, in 2 different installation directories. (I am aware this is not recommended.) Both installations succeeded.
Then I ran the uninstaller of version 3.2alpha, by double-clicking uninstaller.exe in the installation directory of version 3.2alpha. The first window that popped up gave the correct version number, but the second window, "Uninstall Unitex/GramLab", announced "Uninstalling from: (...)Program Files (x86)\Unitex-GramLab-3.1".
I cancelled, but it seems the uninstaller of a version might uninstall another version.
I am reporting this just in case the problem would have a simple solution.

Installer displays confusing message about where workspace will be created

During the operation of the installer, it displays this message:

Setup will create your workspace in the following folder. To select a different folder, click Workspace and (...)
Destination folder where your Unitex/GramLab folder will be created:

This part of the message suggests that the user's Unitex/GramLab workspace folder (or private Unitex directory, as it is named in the Info/Preferences menu) will be created as a subfolder in the folder shown in the field displayed after the message. This is confusing because the rest of the message says that the user's workspace folder will be the folder shown in the field (which is what happens actually).
I suggest replacing the text above by this:

Setup will set the following folder as your workspace. To select a different folder, click Workspace and (...)
Destination folder that will be used as your Unitex/GramLab folder:

This way, the text is consistent and the warning message that may be displayed later becomes understandable. (I opted to choose where I want my Unitex workspace, and the following warning message was displayed:

Your workspace folder: C:\ (...the directory I specified in the field mentioned above...) already exists and is not empty. Continue anyway? Note that this action does not overwrite any existing file in your folder

If the user has specified an existing folder somewhere in one's existing directory tree, understanding that the installer will create his workspace there as a subfolder, this message is inconsistent and confuses them.)

allow user to create workspace at a disk root

When the installer asked where it should create the user's personal workspace, I wanted it to be created directly at the root of disk D:\ so I selected D:\ but the installer did not allow me to go further in the installation and I must cancel.
Thanks

installation directory

The Unitex/GramLab installer proposes to install the system in a default directory.
If the user uninstalls an older version first, he/she may wish to install the new version in the same directory of the other. I suggest offering him/her the choice between the two defaults.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.