Initial revision
[scilab.git] / scilab / README_Windows.txt
1                 Scilab version 2.6 for Windows (NT/2000/95/98)
2                 **********************************************
3  
4  ******************************************************************************
5  0 - COPYRIGHT NOTICE
6  ********************
7  
8  Scilab is free software. 
9  See the included license: "license.txt" in English
10                            "licence.txt" in French
11  
12  ******************************************************************************
13  I - TO RUN SCILAB (BINARY VERSION)
14  **********************************
15  
16     1 - You have already installed Scilab by executing "scilab26.exe".
17         By default Scilab is in "C:\Program Files\Scilab-2.6" directory.
18  
19     2 - Run Scilab by executing "Scilab" from the startup menu.
20         In fact, it is a link to "runscilab.exe" in Scilab subdirectory "bin", 
21         so you can run Scilab by executing directly "runscilab.exe".
22  
23     3 - Scilab has been compiled with Visual C++  (see IV below).
24         All examples of incremental link given with Scilab are prepared
25         for Visual C++.
26  
27     4 - If you have any problems or suggestions concerning Scilab,
28         send an email to:
29         
30                            Scilab@inria.fr
31  
32         or better post a message to newsgroup:
33  
34                       comp.soft-sys.math.scilab
35  
36  ******************************************************************************
37  II - TO UNINSTALL SCILAB (BINARY VERSION)
38  *****************************************
39  
40     To uninstall Scilab you can use the unintaller. You will find it in the 
41     "Scilab 2.6" item of the Program Group.
42     You can also use the Add/Remove Programs of the Control Panel.
43  
44  ******************************************************************************
45  III - TO CUSTOMIZE SCILAB FONTS, WINDOW SIZE and SCILAB MENUS 
46  *************************************************************
47  
48     When you enter Scilab for the first time the window may be too
49     large and the fonts not properly choosen.  Just change this
50     with mouse and menus (right mouse click in the scilab window)
51     and use the "Update scilab.ini" menu to save your changes. The
52     behavior is the same for graphics windows.
53         
54     For the popup help, just change the size and it will keep it for 
55     next calls.
56  
57     You can also edit the files "bin/wscilab.mnu" and
58     "bin/wgscilab.mnu" to customize the Scilab menus. It's quite
59     easy to change them.
60  
61  ******************************************************************************
62  IV - TO COMPILE SCILAB FROM A SOURCE VERSION
63  ********************************************
64  
65     We have compiled this distribution with Visual C++ 6.0. It is
66     possible to compile it with egcs or Cygwin compiler but the
67     incremental link does not work yet.
68  
69     1 - To compile with Visual C++ 4.0,  5.0 or 6.0, edit the beginning of the 
70         file "Makefile.incl.mak". Then type "nmake /f Makefile.mak".
71  
72         If you want to compile with TCL/TK interface, you need to uncomment
73         the corresponding lines in "Makefile.incl.mak". You also need to
74         modify the Makefiles of TCL/TK distribution and recompile it:
75         in files "tcl8.0\win\makefile.vc" and "tk8.0\win\makefile.vc" replace 
76         the line
77         "libcdll = msvcrt.lib oldnames.lib" by
78         "libcdll = libcmt.lib oldnames.lib" and the line
79         "cvarsdll   = $(cvarsmt) -D_DLL" by
80         "cvarsdll   = $(cvarsmt)".
81  
82         If you want to compile with PVM interface, you need to uncomment
83         the corresponding lines in "Makefile.incl.mak". You also need to modify
84         the pathnames of the compiler in the file "conf/WIN32.def" of PVM.
85         Note that at the present time, PVM interface does not work
86         well on Windows.
87  
88     2 - To compile with egcs or Cygwin compiler, try typing "./configure" and 
89         then "make all".
90  
91  ******************************************************************************
92  V - DOCUMENTATION
93  ******************
94  
95  In addition to Scilab online documentation (obtained by typing "help item" or
96  "apropos keyword" or clicking on the help button), you will find 
97  compressed postscript and pdf documentation by anonymous ftp on
98  "ftp.inria.fr:/INRIA/Projects/Meta2/Scilab/doc" (internet# 192.93.2.54)
99  or from Web site
100  "http://www-rocq.inria.fr/scilab":
101  
102  Comm.ps.gz, Comm.pdf: Communication Toolbox
103  Internals.ps.gz, Internals.pdf: Scilab's internals
104  Intro.ps.gz, Intro.pdf: Introduction to Scilab
105  Lmi.ps.gz, Lmi.pdf: Linear Matrix Inequalities Optimization Toolbox
106  Manual.ps.gz, Manual.pdf: On line Manual
107  Metanet.ps.gz, Metanet.pdf: Metanet User's Guide and Tutorial
108  Scicos.ps.gz, Scicos.pdf: Scicos: a Dynamic System Builder and Simulator 
109  Signal.ps.gz, Signal.pdf: Signal Processing Toolbox
110  Intersci.ps.gz, Intersci.pdf: Interfacing Tool
111  
112  ******************************************************************************
113  VI - SOME IMPORTANT FILES AND DIRECTORIES
114  *****************************************
115  
116  scilab.star: startup file for Scilab instructions in this file
117               are executed when Scilab is executed. Note that
118               you can also have your own startup file "scilab.ini" 
119               in your current directory.
120  
121  Makefile.incl.mak: file included by all Makefile's.
122  
123  Version.incl: contains the scilab version. It is used by a few Makefile.
124  
125  Makefile.mak: the main Makefile to make Scilab.
126  
127  config/Makefile.mak  : directory used by the main Makefile
128  
129  demos/    : demos directory. Some of the demos can be executed by clicking
130              on the "demos" button.
131  
132  examples/ : examples of dynamic links and interface code.
133  
134  macros/   : functions directory: this directory is divided into 
135              subdirectories corresponding to specific topics
136              (control, polynomials,...). Each subdirectory contains 
137              the source code of the macros (files *.sci). 
138  
139   libs/   : directory of libraries: archives of object files needed 
140              to link Scilab.
141  
142  routines/ : directory of fortran or C routines. Divided into subdirectories
143              (see below).
144  
145  man/     : files for online help
146  
147  tests/    : set of exec files to test Scilab.
148  
149  util/     : useful routines and ASCII files to manage Scilab.
150  
151  bin/     : executable code and scripts.
152
153                 runscilab : executable code of Scilab.
154                 intersci: generator of interface program between Scilab and 
155                            routines.
156  
157  intersci/ : Generator of interface program between Scilab and routines.
158  
159  maple/    : Maple code to link Maple with Scilab.
160  
161  pvm3/    : PVM 3.4 beta 6 for Scilab.
162  
163  tcl/      : TCL/TK for Scilab.
164  
165  ******************************************************************************
166                                THAT'S ALL FOLKS
167  ******************************************************************************