Update for the 3.1-rc1 version
[scilab.git] / scilab / README_Windows.txt
1                 Scilab version 3.1-rc1 for Windows (95/98/NT/2000/XP)
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 "scilab-3.1-rc1.exe".
17         By default Scilab is in "C:\Program Files\scilab-3.1-rc1" directory.
18  
19     2 - Run Scilab by executing "Scilab 3.1-rc1" from the startup menu.
20         In fact, it is a link to "wscilex.exe" in Scilab subdirectory "bin", 
21         so you can run Scilab by executing directly "wscilex.exe".
22         If you want use Visual Studio (6,.NET) with Scilab 3.1-rc1,
23         execute "Scilab 3.1-rc1 (requires Visual Studio)" from the startup menu.
24  
25     3 - Scilab has been compiled with Visual C++ .NET 2003
26         (Intel C 8.0 & Fortran 8.0, see IV below).
27         All examples of incremental link given with Scilab are prepared
28         for Visual C++.
29  
30     4 - If you want use LCC-Win32 (C compiler) with Scilab 3.1-rc1
31         See Readme_LCC.txt in lcc directory.
32         You can download at http://www.cs.virginia.edu/~lcc-win32/
33     
34     5 - If you have any problems or suggestions concerning Scilab,
35         http://www.scilab.org/cgi-bin/bugzilla_bug/index.cgi        
36         or better post a message to newsgroup:
37         comp.soft-sys.math.scilab
38
39
40 ******************************************************************************
41 II - TO UNINSTALL SCILAB (BINARY VERSION)
42 ******************************************************************************
43  
44     To uninstall Scilab you can use the unintaller. You will find it in the 
45     "Scilab 3.1-rc1" item of the Program Group.
46     You can also use the Add/Remove Programs of the Control Panel.
47  
48 ******************************************************************************
49 III - TO CUSTOMIZE SCILAB FONTS, WINDOW SIZE and SCILAB MENUS 
50 ******************************************************************************
51  
52     When you enter Scilab for the first time the window may be too
53     large and the fonts not properly choosen.  Just change this
54     with mouse and menus (right mouse click in the scilab window),
55     when you close scilab your changes are saved.
56         
57     For the popup help, just change the size and it will keep it for 
58     next calls.
59  
60     You can also edit the files "bin/wscilabE.mnu" and
61     "bin/wgscilabE.mnu" to customize the Scilab menus. It's quite
62     easy to change them.
63  
64 ******************************************************************************
65 IV - TO COMPILE SCILAB FROM A SOURCE VERSION
66 ******************************************************************************
67  
68     We have compiled this distribution with Visual Studio 2003 (Intel C 8.0 &
69     Fortran 8.0). It is possible to compile it with egcs or Cygwin compiler.
70
71     1 - To compile with Visual C++.NET 2003 & Intel Fortran 8.0,
72         see Readme_visual.txt 
73  
74     2 - To compile with Visual C++ 4.0,  5.0 or 6.0, edit the beginning of the 
75         file "Makefile.incl.mak". Then type "nmake /f Makefile.mak".
76  
77         If you want to compile with TCL/TK interface, you need to uncomment
78         the corresponding lines in "Makefile.incl.mak". 
79  
80         If you want to compile with PVM interface, you need to uncomment
81         the corresponding lines in "Makefile.incl.mak". You also need to modify
82         the pathnames of the compiler in the file "conf/WIN32.def" of PVM.
83  
84
85  
86 ******************************************************************************
87 V - DOCUMENTATION
88 ******************************************************************************
89  
90  In addition to Scilab online documentation (obtained by typing "help item" or
91  "apropos keyword" or clicking on the help button), you will find 
92  compressed postscript and pdf documentation by anonymous ftp on
93  "ftp.inria.fr:/INRIA/Projects/Scilab"
94  or from Web site
95  "http://www.scilab.org":
96  
97  Internals.ps.gz, Internals.pdf: Scilab's internals
98  Intro.ps.gz, Intro.pdf: Introduction to Scilab
99  Lmi.ps.gz, Lmi.pdf: Linear Matrix Inequalities Optimization Toolbox
100  Manual.ps.gz, Manual.pdf: On line Manual
101  Metanet.ps.gz, Metanet.pdf: Metanet User's Guide and Tutorial
102  Scicos.ps.gz, Scicos.pdf: Scicos: a Dynamic System Builder and Simulator 
103  Signal.ps.gz, Signal.pdf: Signal Processing Toolbox
104  Intersci.ps.gz, Intersci.pdf: Interfacing Tool
105  
106  Note that these documents are not uptodate.
107
108 ******************************************************************************
109 VI - SOME IMPORTANT FILES AND DIRECTORIES
110 ******************************************************************************
111  
112  scilab.star: startup file for Scilab instructions in this file
113               are executed when Scilab is executed. Note that
114               you can also have your own startup file "scilab.ini" 
115               in your current directory.
116  
117  Makefile.incl.mak: file included by all Makefile's.
118  
119  Version.incl: contains the scilab version. It is used by a few Makefile.
120  
121  Makefile.mak: the main Makefile to make Scilab.
122  
123  config/Makefile.mak  : directory used by the main Makefile
124  
125  demos/    : demos directory. Some of the demos can be executed by clicking
126              on the "demos" button.
127  
128  examples/ : examples of dynamic links and interface code.
129  
130  macros/   : functions directory: this directory is divided into 
131              subdirectories corresponding to specific topics
132              (control, polynomials,...). Each subdirectory contains 
133              the source code of the macros (files *.sci). 
134  
135  libs/     : directory of libraries: archives of object files needed 
136              to link Scilab.
137  
138  routines/ : directory of fortran or C routines.
139  
140  man/      : files for online help
141  
142  tests/    : set of exec files to test Scilab.
143  
144  util/     : useful routines and ASCII files to manage Scilab.
145  
146  bin/      : executable code and scripts.
147
148                 scilex  : executable code of Scilab (Console version).
149                 wscilex  : executable code of Scilab (Windows version).
150                 intersci: generator of interface program between Scilab and 
151                            routines.
152  
153  intersci/ : Generator of interface program between Scilab and routines.
154  
155  maple/    : Maple code to link Maple with Scilab.
156  
157  pvm3/    : PVM 3 for Scilab.
158  
159  tcl/      : TCL/TK for Scilab.
160  
161  ******************************************************************************
162                                THAT'S ALL FOLKS
163  ******************************************************************************