summaryrefslogtreecommitdiffstats
path: root/scilab_doc/toolbox_guide/toolbox_example/README
blob: 1b5d6460282f991a7d6455fd78a9ed31feb8e85c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
                Guide for the toolboxes contribution
                ===================================



Guide (version xxx)
====================

Information about toolbox_example can be found at 
http://xxx.xxx//toolbox_example.html

The program has been written by 
XXXXXXXXX


Installation
============
To Install this toolbox: (Scilab-4.0)

We Suppose here that <PATH> stands for the path of the directory
containing this README file.

- On Unix/Linux systems
     * User
        Has to execute,once and for all, the following instruction 
        within Scilab:
        exec <PATH>/builder.sce 
        
        Should execute the following instruction within Scilab:
        exec <PATH>/loader.sce 
        before using the toolbox, he  can also put it  in his
        .scilab startup file for automatic loading.

- On Windows systems
     * user
        Has to execute, once and for all, the following instruction 
        within Scilab:
        exec <PATH>\builder.sce     
        
Should execute the following instruction within Scilab:
        exec <PATH>\loader.sce
        before using the toolbox, he  can also put it in his
        .scilab startup file for automatic loading.


Contents
========
README			: this file
builder.sce		: script to launche the sub-builders
loader.sce		: script to launche the sub-loaders

src			: directory of Fortran and C routines
	builder.sce	: script for building library (compilation and linking)
     	loader.sce	: script for loading library (generated)

macros			: directory of Scilab functions
	builder.sce 	: script for building library
	loader.sce  	: script for loading library
	*.sci		: source versions
	*.bin		: precompiled binary versions (generated)
	lib		: scilab library binary save (generated)

man			: directory for help.
	builder.sce	: translates the xml files to html
	loader.sce	: add your help functions files in the help Scilab browser   
	*.xml		: xml help file 
	*.html		: html help file (generated) 
	whatis		: short function description (generated) 

demos			: examples to illustrate your toolbox

tests			: directory of tests
	tests.sce	: script to test toolbox_example