Skip to content

Commit

Permalink
document new --compress flag
Browse files Browse the repository at this point in the history
  • Loading branch information
totalspectrum committed Dec 22, 2023
1 parent e656325 commit bfae311
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 1 deletion.
38 changes: 37 additions & 1 deletion COPYING
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Spin to C++ / PASM translator

Copyright 2011-2023 Total Spectrum Software Inc.
Bytecode back end Copyright 2021-2023 Ada Gottensträter
Copyright 2021-2023 Ada Gottensträter

+--------------------------------------------------------------------
¦ TERMS OF USE: MIT License
Expand Down Expand Up @@ -73,3 +73,39 @@ spin2cpp makes use of the mcpp preprocessor. The copyright for that is:
* SUCH DAMAGE.
*/

============================================================================

The LZ4 library used to compress executables is based on the LZ4 code at
http://www.lz4.org, and the copyright is:

LZ4 - Fast LZ compression algorithm
Copyright (C) 2011-2020, Yann Collet.

BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

You can contact the author at :
- LZ4 homepage : http://www.lz4.org
- LZ4 source repository : https://github.com/lz4/lz4
1 change: 1 addition & 0 deletions Changelog.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Version 6.8.0
- Added support for `%"xyzw"` constants in Spin2
- Added locking for host file system I/O
- Added `--compress` flag to compress binaries (courtesy of Ada)
- Fixed incorrect inline assembly for `#outb` and other hw registers
- Supported PNut v43 `{Spin2_vNN}` version comments

Expand Down
1 change: 1 addition & 0 deletions doc/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,7 @@ There are various command line options for the compiler which may modify the com
C = latin1 for Latin-1 encoding
C = parallax for Parallax font encoding
[ --code=cog ] compile to run in COG memory instead of HUB
[ --compress ] compress output binary for faster download
[ --fcache=N ] set size of FCACHE space in longs (0 to disable)
[ --fixedreal ] use 16.16 fixed point instead of IEEE floating point
[ --lmm=xxx ] use alternate LMM implementation for P1
Expand Down
1 change: 1 addition & 0 deletions flexspin.c
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Usage(FILE *f, int bstcMode)
fprintf(f, " [ --charset=xxx ] set character set for runtime\n");
fprintf(f, " xxx is one of utf8, latin1, shiftjis, or parallax\n");
fprintf(f, " [ --code=cog ] compile for COG mode instead of LMM\n");
fprintf(f, " [ --compress ] compress output binary for faster download\n");
fprintf(f, " [ --interp=rom ] compile bytecodes for P1 ROM interpreter (alpha feature!)\n");
fprintf(f, " [ --interp=nu ] compile bytecodes for NuCode interpreter (alpha feature!)\n");
fprintf(f, " [ --fcache=N ] set FCACHE size to N (0 to disable)\n");
Expand Down

0 comments on commit bfae311

Please sign in to comment.