Mercurial > forge
annotate README @ 12677:e083820799fe octave-forge
prepare for release
author | cdf |
---|---|
date | Mon, 17 Aug 2015 17:10:27 +0000 |
parents | 78fb27c2d2b4 |
children |
rev | line source |
---|---|
333 | 1 *** README is automatically generated from admin/template.readme *** |
2 | |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
3 The octave-forge project contains functions for Octave which are not in |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
4 the main distribution. While the main Octave distribution is |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
5 conservative about accepting new functions and changes, octave-forge is |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
6 very open. As a result, be prepared for some lower quality code and |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
7 more rapidly changing interfaces to the functions in octave-forge. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
8 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
9 The collection is in the public domain, but the individual functions |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
10 vary. See COPYING for details. See INSTALL for installation |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
11 instructions. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
12 |
1876
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
13 Octave needs your support! Please donate to the University of |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
14 Wisconsin Foundation: |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
15 |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
16 http://www.uwfoundation.wisc.edu/index.html |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
17 |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
18 designated as follows: |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
19 |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
20 I/we wish to support ongoing development of the Octave modelling |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
21 language, under the supervision of Professor James B. Rawlings and |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
22 Dr. John W. Eaton of the Department of Chemical and Biological |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
23 Engineering at the University of Wisconsin-Madison. |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
24 |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
25 Donations are tax deductible in the United States. A donation of $10/user |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
26 per year at current estimates of the user base would support two developers. |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
27 Adjust as appropriate for the percentage of users that you think will donate. |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
28 |
14e741839b44
Move suggestion to donate from octave-forge site to octave-forge README
pkienzle
parents:
333
diff
changeset
|
29 |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
30 ===================================================================== |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
31 Project organization |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
32 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
33 admin/ |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
34 Contains files and scripts used to administer the octave-forge |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
35 website and build the release files. Nothing in here is needed |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
36 by octave-forge users. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
37 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
38 doc/ |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
39 Documentation for octave in general. Documentation for specific |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
40 packages goes into the doc/ subdirectory of the individual package |
3256 | 41 directories. This directory also contains the automatically built |
3037
3e10bc83ccbf
Rearrange the html build, isolating all scripts in admin/ and all docs in doc/.
adb014
parents:
3006
diff
changeset
|
42 html code for the website. |
3e10bc83ccbf
Rearrange the html build, isolating all scripts in admin/ and all docs in doc/.
adb014
parents:
3006
diff
changeset
|
43 |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
44 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
45 extra/ |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
46 Packages which: |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
47 * are too narrow in scope for main/, or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
48 * act as alternatives for functions in main/, or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
49 * do not follow octave conventions (because they want |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
50 to retain compatibility with matlab for example), or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
51 * are primarily developed elsewhere, or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
52 * require patches to Octave, or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
53 * are designed for older versions of Octave, or |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
54 * haven't been tested enough. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
55 |
3006 | 56 language/ |
57 Packages that supply translations of core Octave functions and | |
58 Octave-Forge packages. The directory base/template/ contains example | |
59 code to and the directory base/help the original text of the functions | |
60 to translate. | |
61 | |
62 | |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
63 main/ |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
64 Packages which may eventually be included in the main octave |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
65 distribution. As such, they should follow Octave conventions. |
3967 | 66 The octave-forge SVN tree should be the primary development/release |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
67 site. All functions should work with the latest Octave |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
68 interpreter without any special compilation switches or patches |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
69 applied. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
70 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
71 nonfree/ |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
72 Packages which are not freely modifiable and redistributable |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
73 with modifications, or which depend on code which is not |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
74 free. This includes functions which only permit non-commercial |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
75 use and functions which must be kept together as a package. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
76 Functions in all other directories must be freely redistributable |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
77 with modifications. Functions in non-free must be freely |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
78 redistributable for non-commercial use. Functions of unknown |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
79 license should not be included anywhere, since no license implies |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
80 default license implies no rights to redistribute. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
81 |
2496 | 82 packages/ |
83 This is the target directory, where the source packages are placed. It | |
84 is also the directory where the test code is run for each of the | |
85 packages and where the source RPMs are automatically built. There | |
86 should be no reason for the user to add files to this directory | |
87 | |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
88 ====================================================================== |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
89 Package organization |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
90 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
91 package/NOINSTALL |
2480 | 92 This is an optional file, whose presence tells octave-forge |
93 that this package should be ignored. This is typically for | |
94 packages that are kept for historical reasons. | |
95 package/DESCRIPTION | |
96 This is a required file containing information about the | |
97 package. | |
98 package/COPYING | |
99 This is a required containing the license of the package. | |
333 | 100 package/INDEX |
2480 | 101 This is an optional file describing the functions provided by |
102 the package. | |
103 package/PKG_ADD | |
104 An optional file that includes commands that are run when the | |
105 package is added to the users path. | |
106 package/PKG_DEL | |
107 An optional file that includes commands that are run when the | |
108 package is removed from the users path. | |
109 package/Makefile | |
110 This is an optional file that is for the use of Octave-Forge | |
111 only. | |
112 package/pre_install.m | |
113 This is an optional script that is run prior to the | |
114 installation of a package. | |
115 package/post_install.m | |
116 This is an optional script that is run after the | |
117 installation of a package. | |
118 package/on_uninstall.m | |
119 This is an optional script that is run prior to the | |
120 de-installation of a package. | |
121 package/doc | |
122 An optional directory containing documentation for the | |
123 package. | |
124 package/inst | |
125 An optional directory containing any files that are directly | |
126 installed by package. | |
127 package/bin | |
128 An optional directory containing files that will be added to | |
129 the Octave EXEC_PATH when the package is loaded. | |
130 package/src | |
131 An optional directory containing code that must be 'built' prior | |
132 to the packages installation. | |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
133 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
134 ========================================================================== |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
135 Administrative files |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
136 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
137 autogen.sh |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
138 Generates ./configure and Makeconf.in |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
139 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
140 configure.base |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
141 Makeconf.base |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
142 Basic configuration checks, such as locating the install paths, |
2480 | 143 and the associated variables to be put into Makeconf. |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
144 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
145 COPYING |
2480 | 146 License for the collection |
197
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
147 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
148 COPYING.GPL |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
149 The text of the GPL license |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
150 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
151 README |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
152 This file |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
153 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
154 TODO |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
155 Things that could/should be done |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
156 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
157 INSTALL |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
158 Installation instructions |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
159 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
160 Makefile |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
161 Top level makefile |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
162 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
163 release.sh |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
164 Generates release tarball |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
165 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
166 ========================================================================== |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
167 Compatibility Issues |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
168 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
169 Issue the following command: |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
170 $ grep -d skip "XXX COMPATIBILITY XXX" */* */*/* |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
171 for a list of compatibility issues in various functions. As of this |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
172 writing, mu2lin is a likely cause of problems when porting audio |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
173 packages. |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
174 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
175 |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
176 ========================================================================== |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
177 Paul Kienzle |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
178 pkienzle@users.sf.net |
4a887a9837c1
leaving README in CVS tree as a guide to casual browsers even though it
pkienzle
parents:
diff
changeset
|
179 March 17, 2002 |