summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authordon bright <hugh.m.bright@gmail.com>2013-01-28 02:42:20 (GMT)
committerdon bright <hugh.m.bright@gmail.com>2013-01-28 02:42:20 (GMT)
commit1e64dddf1ea30282c89de7f35854a68614234652 (patch)
tree165d37c1c66f6ff79d48c74794238b3f0bed09da /doc
parent5c779159c208ca3d88c88479ab29f9cd66574859 (diff)
parentd0856efe6da545693f9c50a8a2514a9f999ab5ef (diff)
Merge branch 'master' of github.com:openscad/openscad into issue159
Diffstat (limited to 'doc')
-rw-r--r--doc/TODO.txt4
-rw-r--r--doc/release-checklist.txt63
-rw-r--r--doc/testing.txt4
3 files changed, 45 insertions, 26 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt
index 7f8378d..62db614 100644
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@@ -113,6 +113,7 @@ o Misc
for confirmation.
- Go through keyboard shortcuts and make them more conformant to platform standards
- Show design info/stats (sizes, caches etc.)
+ - Support Voice Over and related technologies for vision-impaired users
o Cmd-line
- Add verbose option (PRINT command from mainwin.cc and progress output)
@@ -135,6 +136,7 @@ o Hollow donut problem
rendering keeps the hole, but renders slightly incorrect.
o CGAL issues
- CGAL doesn't handle almost planar polygons. Consider splitting into triangles ourselves. See WillamAdams/dodec.scad
+o Look at the EPEC kernel for improved performance (suggested by Giles)
LANGUAGE && BUILTINS
--------------------
@@ -239,6 +241,8 @@ o Collect "all" available OpenSCAD scripts from the internets and run the integr
MISSING TESTS:
--------------
+o cmd-line -D variable override
+o OPENSCADPATH env.variable
o all functions
o mirror
o scale
diff --git a/doc/release-checklist.txt b/doc/release-checklist.txt
index e85e97c..6d53ad9 100644
--- a/doc/release-checklist.txt
+++ b/doc/release-checklist.txt
@@ -1,6 +1,8 @@
OpenSCAD Release Checklist
--------------------------
+(See bottom of this file for how to build release binaries)
+
o Update VERSION environment variable
export VERSION=2012.08
@@ -12,6 +14,7 @@ o Update VERSION environment variable
scripts/publish-mingw-x.sh
o Update RELEASE_NOTES
+o Update copyright year in AboutDialog.html and mainwin.cc
o Tag release
git tag "openscad-$VERSION"
@@ -19,33 +22,15 @@ o Tag release
o build source package
scripts/git-archive-all.py --prefix=openscad-$VERSION/ openscad-$VERSION.src.tar.gz
-o build binaries
- tar xzf openscad-$VERSION.src.tar.gz
- cd openscad-$VERSION
- Mac OS X
- (For Qt-4.7.3: Remove /Developers/Applications/Qt/plugins/qmltooling)
- ./scripts/publish-macosx.sh -> OpenSCAD-$VERSION.dmg
- Linux:
- 32-bit: run on a 32-bit machine or VM
- 64-bit: run on a 64-bit machine or VM
- ./scripts/release-common.sh -> openscad-$VERSION.x86-ARCH.tar.gz
- (where ARCH will be detected and set to 32 or 64)
- Windows mingw cross-build: FIXME 32 vs. 64 bit
- ./scripts/publish-mingw-x.sh -> mingw32/Openscad-$VERSION.zip
- -> mingw32/Openscad-$VERSION-Installer.exe
-
-o FIXME: Run some tests
-
-o Remove VERSION environment variable
-
- export VERSION=
+o Sanity check; build a binary or two and manually run some tests
o git push --tags
-o Upload
- - Github
- Upload manually here: https://github.com/openscad/openscad/downloads
- FIXME: Write a script
+o Upload Source package
+ $ ./scripts/googlecode_upload.py -s 'Source Code' -p openscad -l Featured,Type-Source openscad-$VERSION.src.tar.gz
+
+o Remove VERSION environment variable
+ $ unset VERSION
o Update web page
o Write email to mailing list
@@ -53,3 +38,33 @@ o Update external resources:
- http://en.wikipedia.org/wiki/OpenSCAD
o Notify package managers
- Ubuntu: https://launchpad.net/~chrysn
+ - MacPorts:
+
+
+Build and Upload Release Binaries
+---------------------------------
+
+$ export VERSION=<openscad version, e.g. 2013.01>
+$ tar xzf openscad-$VERSION.src.tar.gz
+$ cd openscad-$VERSION
+
+Mac OS X:
+
+ $ ./scripts/publish-macosx.sh -> OpenSCAD-$VERSION.dmg
+
+Linux:
+ 32-bit: run on a 32-bit machine or VM
+ 64-bit: run on a 64-bit machine or VM
+
+ $ ./scripts/release-common.sh -> openscad-$VERSION.x86-ARCH.tar.gz
+ (where ARCH will be detected and set to 32 or 64)
+ $ ./scripts/googlecode_upload.py -s 'Linux Binaries' -p openscad openscad-$VERSION.x86-ARCH.tar.gz -l Featured,OpSys-Linux,Type-Archive openscad-$VERSION.x86-ARCH.tar.gz
+ o Update web page with download links
+
+Windows mingw cross-build: FIXME 32 vs. 64 bit
+
+ $ ./scripts/publish-mingw-x.sh -> mingw32/Openscad-$VERSION.zip
+ -> mingw32/Openscad-$VERSION-Installer.exe
+ $ ./scripts/googlecode_upload.py -s 'Windows Binaries' -p openscad OpenSCAD-$VERSION.zip -l Featured,OpSys-Windows,Type-Archive OpenSCAD-$VERSION.zip
+ $ ./scripts/googlecode_upload.py -s 'Windows Installer' -p openscad OpenSCAD-$VERSION-Installer.exe -l Featured,OpSys-Windows,Type-Installer OpenSCAD-$VERSION-Installer.exe
+ o Update web page with download links
diff --git a/doc/testing.txt b/doc/testing.txt
index 8ab1cee..bbd7c18 100644
--- a/doc/testing.txt
+++ b/doc/testing.txt
@@ -85,7 +85,7 @@ Some versions of Xvfb may fail, however.
1. Trouble finding libraries on unix
- To help CMAKE find eigen2, OpenCSG, CGAL, Boost, and GLEW, you can use
+ To help CMAKE find eigen, OpenCSG, CGAL, Boost, and GLEW, you can use
environment variables, just like for the main qmake & openscad.pro. Examples:
OPENSCAD_LIBRARIES=$HOME cmake .
@@ -93,7 +93,7 @@ Some versions of Xvfb may fail, however.
Valid variables are as follows:
- BOOSTDIR, CGALDIR, EIGEN2DIR, GLEWDIR, OPENCSGDIR, OPENSCAD_LIBRARIES
+ BOOSTDIR, CGALDIR, EIGENDIR, GLEWDIR, OPENCSGDIR, OPENSCAD_LIBRARIES
When running, this might help find your locally built libraries (assuming
you installed into $HOME)
contact: Jan Huwald // Impressum