#---------------------------------------------------------------------------------
# NAB Plug-in README
#
# < Native Application Builder Plug-in >
#
#---------------------------------------------------------------------------------
# Copyright 2005, 2006 FUJITSU LIMITED
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License (EPL).
# which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html
# 
# Contributors:
#     Fujitsu Ltd.
#---------------------------------------------------------------------------------

[Contents]

  1.   Introduction
  2.   About NAB
  3.   Functions
  4.   License
  5.   Software Structure
  6.   System Requirements
  7.   Installation
  7.1  Win32 Installation
  7.2  Linux Installation
  8.   Limitations
  9.   Known Bugs
  10.  Documents
     
#---------------------------------------------------------------------------------

1. Introduction

  This document is describing about NAB plug-in version [Ver-0.9.6]. 

2. About NAB

  The Native Application Builder (NAB) project creates faramework to build a C++
  and several languages GUI applications. The goal is to allow the user to write a
  GUI application once and build it for many platforms without changing the
  code.

  Since the scope of the DSDP project is the embedded space, the NAB project was
  created to bring into Eclipse the portionsof the WideStudio tool that are
  focused on building embedded GUIfs in C++.
  
  Conceptually, this is similar to SWT and JFace, with the notable exception that
  the NAB tool is written in C++ and designed for use in C++ applications. 
  
  The NAB tool uses MWT libraries from WideStudio/MWT open source project.
  The application made with MWT libraries runs in various environments including
  Windows, Linux, and T-Engine. Moreover, a peculiar native code to the platform
  can be made only by compiling again because there is source code
  interchangeability between different environments.

  The MWT libraries are not included in the project, since they are run-time
  implementations for multiple operating systems, many of which are not embedded.
  Users of NAB can pick up the desired run-time portions from the WideStudio
  website.

  Please see the following WEB sites for more details about WideStudio/MWT. 
    
  Japanese:   http://www.widestudio.org/ja
  English:    http://www.widestudio.org/EE
  Portuguese: http://www.widestudio.org/pt
  Chinese:    http://www.widestudio.org/cn
  Korean:     http://www.widestudio.org/ko

3. Functions

  The NAB plug-in provides the function to make GUI application of the 
  MWT libraries in the WYSIWYG environment. The function equal to WideStudio 
  Application Builder is concretely achieved by the combination with the CDT 
  plug-in in the Eclipse platform. 

  - GUI Edit Function
    MWT parts are generated as well as the VE plug-in for the Java language, and 
    can visually arrange, edit, and the source code be generated. Various GUI 
    parts can be arranged with the mouse to build the application window, and 
    attributes of parts can be specified visually. 

  - The MWT application C/C++ Programming Function
     Event procedures of each MWT parts are generated automatically. Moreover, the 
     processing program can be adding described at each event processing. 

  - MWT Application Build/Execution Function
    The source code can be compiled and an executable application can be 
    generated. Moreover, the application can be executed in the Eclipse 
    environment. 

  - Project Save/Restore Function
    It is possible to use the project saved data made with the WideStudio/MWT 
    application builder by the NAB plug-in. 

4. License

  The NAB  plug-in is distributed with Eclipse Public License - v 1.0. 
  Please refer to the original in http://www.eclipse.org/legal/epl-v10.html. 

5. Software Structure

  The NAB plug-in is composed of the nab.core package and the nab.mwt package
  group.

  NAB plug-in
    org.eclipse.nab.core       : Core plug-in
    org.eclipse.nab.mwt        : nab plug-in for MWT
    org.eclipse.nab.mwt.native : Win32 native plug-in
                               : Linux native plug-in
    org.eclipse.nab.mwt.jni    : JNI plug-in for native MWT
    org.eclipse.nab.mwt.doc    : Document plug-in

6. System Requirements

  The following software is needed to execute the NAB  plug-in. Please install 
  these before you install the NAB  plug-in. 

  (1) Microsoft Windows platform
    Necessary software list of Microsoft Windows platform
     - JDK            : JavaTM 2 SDK and Standard Edition Version 1.4.2 Windows version
     - Eclipse        : Eclipse 3.2.X Microsoft Windows version
     - CDT plug-in    : The CDT 3.1.X WIN32 version
     - WideStudio/MWT : WideStudio/MWT 3.96-1 WIN32 version

  (2) Linux platform
    Necessary software list of Linux platform
     - JDK         : JavaTM 2 SDK and Standard Edition Version 1.4.2 Linux version
     - Eclipse     : Eclipse 3.2.X Linux GTK version
     - CDT plug-in : CDT 3.0.X Linux version
     - WideStudio/MWT : WideStudio/MWT 3.96-1

7. Installation

  The installation method is different according to the platform. Each 
  installation procedure is shown below. 

  7.1 Win32 Installation

    Please install the Win32 edition according to the following procedure. 

    (1) JDK (JavaTM 2 SDK, Standard Edition Version 1.4.2 and later) installation
        Install JDK, it is distributed from
        http://java.sun.com/j2se/1.4.2/download.html

    (2) WideStudio/MWT (edition of WIN32) installation
        It is distributed from http://www.widestudio.org/EE/download-win32.html
        Unzip wswin400-1.zip and execute Setup.exe it is exist in the unzipped 
        folder, then the installation begins. 
        In the programming language selection during the installation of the 
        WideStudio/MWT application builder, you can set an arbitrary language.
        At the end, please reboot PC once after the installation.

    (3) Eclipse 3.2.X  (edition of WIN32) installation
        Unzip eclipse-SDK-3.2.X-win32.zip and install it. It is distributed from 
        www.eclipse.org. 

    (4) CDT plug-in installation
        Unzip org.eclipse.cdt.sdk-3.1.X-win32.x86.zip to the folder that Eclipse 
        was installed. It is distributed from www.eclipse.org  

    (5) NAB  plug-in installation 
        Unzip the following files to the folder that Eclipse was installed.
          nab-mwt.win32.0.9.6.zip
          nab-mwt.doc.0.9.6.zip

  7.2 Linux Installation

    Please install the Linux(GTK) version according to the following procedure. 

    (1) JDK (JavaTM 2 SDK, Standard Edition Version 1.4.2) installation
        http://java.sun.com/j2se/1.4.2/download.html

    (2) WideStudio/MWT installation
        Unzip ws-v3.96.1-src.tar.gz and execute the following commands on the 
        console to install it. 
        It is offered by http://www.widestudio.org/EE/download.html.

        $ cd <any directory>
        $ tar -zxvf ws-v3.96.1-src.tar.gz
        $ cd ws-v3.96-1/src
        $ ./configure
        $ make runtime
        $ make mwt_java
        $ su
        # make install

        At the end, please add the "/usr/local/lib" path to LD_LIBRARY_PATH 
        environment variable. 

    (3) Eclipse 3.2.X  (Linux version) installation
        Unzip eclipse-SDK-3.2.X-linux-gtk.zip and install it. It is distributed 
        from www.eclipse.org. 

    (4) CDT plug-in installation
        Unzip org.eclipse.cdt.sdk-3.1.X-linux.x86.zip to the folder that Eclipse 
        was installed. It is distributed from www.eclipse.org  

    (5) NAB  plug-in installation 
        Unzip the following files to the folder that Eclipse was installed.
          nab-mwt.linux-gtk.0.9.6.zip
          nab-mwt.doc.0.9.6.zip

8. Limitations

  There are the following limitations in this Beta version of NAB plug-in. 

  (1) Can't edit multiple NAB/MWT projects simultaneously.
      In opening a new project while other project which is already opend will be 
      closed.

  (2) Even if the source code file is added to the CDT project, NAB/MWT project  can 
      not build it. Please add it as MWT event procedure. 

9. Documents

  The manuals of Native Application Builder plug-in in HTML format are
  in the [Help] menu of Eclipse.
  
  Moreover, please refer to the following WEB sites for the manual concerning 
  WideStudio/MWT . 

  WideStudio/MWT programming guide:
    English  http://www.widestudio.org/EE/prog-doc/prog.html
    Japanese http://www.widestudio.org/ja/prog-doc/prog.html

  MWT Class Library Reference:
    English  http://www.widestudio.org/EE/ht-ref/objects.html
    Japanese http://www.widestudio.org/ja/ht-ref/objects.html
    
[EOF]
