summaryrefslogtreecommitdiffstats
path: root/scilab_doc
diff options
context:
space:
mode:
authorFarid Belahcene <farid.belahcene@inria.fr>2006-09-01 09:22:53 +0000
committerFarid Belahcene <farid.belahcene@inria.fr>2006-09-01 09:22:53 +0000
commit5488db444035768fc86c81961829c38cdb901a25 (patch)
tree06d1cf42e63d918dbe498b596f4ea74d7d1615b0 /scilab_doc
parentd63bfc470bf7e28c0af8a2794c7cecaabb52e311 (diff)
downloadscilab-5488db444035768fc86c81961829c38cdb901a25.zip
scilab-5488db444035768fc86c81961829c38cdb901a25.tar.gz
add readme.txt file
Diffstat (limited to 'scilab_doc')
-rw-r--r--scilab_doc/toolbox_guide/toolbox_example/readme.txt80
1 files changed, 80 insertions, 0 deletions
diff --git a/scilab_doc/toolbox_guide/toolbox_example/readme.txt b/scilab_doc/toolbox_guide/toolbox_example/readme.txt
new file mode 100644
index 0000000..7ae1b90
--- /dev/null
+++ b/scilab_doc/toolbox_guide/toolbox_example/readme.txt
@@ -0,0 +1,80 @@
1 Guide for the toolboxes contributions
2 =====================================
3
4
5
6Guide (version xxx)
7====================
8
9Information about mytoolbox can be found at
10http://xxx.xxx/mytoolbox.html
11
12The program has been written by
13XXXXXXXXX
14
15
16Installation
17============
18To Install this toolbox: (Scilab-4.0)
19
20We Suppose here that <PATH> stands for the path of the directory
21containing this readme file.
22
23- On Unix/Linux systems
24 * User
25 Has to execute,once and for all, the following instruction
26 within Scilab:
27 exec('<PATH>/builder.sce')
28
29 Should execute the following instruction within Scilab:
30 exec('<PATH>/loader.sce')
31 before using the toolbox, he can also put it in his
32 .scilab startup file for automatic loading.
33
34- On Windows systems
35 * user
36 Has to execute, once and for all, the following instruction
37 within Scilab:
38 exec <PATH>\builder.sce
39
40Should execute the following instruction within Scilab:
41 exec <PATH>\loader.sce
42 before using the toolbox, he can also put it in his
43 .scilab startup file for automatic loading.
44
45
46Contents
47========
48readme.txt : this file
49license.txt : license and copyright of your package
50builder.sce : script to launche the sub-builders
51loader.sce : script to launche the sub-loaders
52
53src : directory of Fortran and C routines
54 buildsrc.sce : script for building library (compilation and linking)
55 loadsrc.sce : script for loading library (generated)
56
57sci_gateway : directory of interfaces programs
58
59includes : .h files
60
61macros : directory of Scilab functions
62 builmacros.sce : script for building library
63 loadmacros.sce : script for loading library
64 *.sci : source versions
65 *.bin : precompiled binary versions (generated)
66 lib : scilab library binary save (generated)
67
68help : directory for help.
69 buildhelp.sce : translates the xml files to html
70 loadhelp.sce : add your help functions files in the help Scilab browser
71 *.xml : xml help file
72 *.html : html help file (generated)
73 whatis : short function description (generated)
74
75etc : .html, .pdf, .txt, .jpeg, ...
76
77demos : examples to illustrate your toolbox
78
79unit tests : directory of tests
80 tests.sce : script to test toolbox_example \ No newline at end of file