Migrated to Markdown; noted license change
diff --git a/source/1.0/doc/CHANGES-1.0.md b/source/1.0/doc/CHANGES-1.0.md
new file mode 100644
index 0000000..dee1408
--- /dev/null
+++ b/source/1.0/doc/CHANGES-1.0.md
@@ -0,0 +1,155 @@
+Changes in shFlags 1.0.x
+========================
+
+Changes with 1.0.4
+------------------
+
+Changed from the LGPL v2.1 license to the Apache v2.0 license so that others can
+include the library or make changes without needing to release the modified
+source code as well.
+
+Moved documentation to Markdown.
+
+Migrated the code to GitHub as code.google.com is turning down.
+
+Fixed issue #10. Usage of `expr` under FreeBSD 7.2 (FreeNAS 0.7.1) and FreeBSD
+8.0 that was causing many unit tests to fail.
+
+Fixed issue where booleans were sometimes mis-configured to require additional
+values like other flags.
+
+Changed `_flags_fatal()` to exit with `FLAGS_ERROR` immediately.
+
+Fixed issue #11. When help is requested, the help flag is no longer prefixed
+with [no].
+
+Upgraded shUnit2 to 2.1.6.
+
+Fixed issue #12. Requesting help shouldn't be considered an error.
+
+Added the ability to override the use of the OS default `getopt` command by
+defining the `FLAGS_GETOPT_CMD` variable.
+
+Updated `gen_test_results.sh` and versions from shUnit2 source.
+
+Fixed issues# 13, 14. Added support for dashes ('-') in long flag names. The
+defined flag will still be declared with underscores ('_') due to shell
+limitations, so only one of a dashed flag name or an underscored flag name are
+allowed, not both.
+
+Issue #20. Updated LGPL v2.1 license from
+http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt.
+
+Issue #15. Use `gexpr` instead of `expr` on BSD variants.
+
+Minor tweaks to make run on FreeBSD 9.1.
+
+Fixed issue in `shflags_test_public.sh` where screens >80 columns were causing a
+test to fail.
+
+Issue #22. Fixed broken testGetFlagInfo() test.
+
+Created alternate `validFloat()` and `validInt()` functions that use shell
+built-ins where possible to increase performance and reduce the usage of the
+`expr` command.
+
+Added separate built-in and `expr` functions for doing math.
+
+
+Changes with 1.0.3
+------------------
+
+MAJOR CHANGE! `FLAGS_ARGC` is now obsolete, and is replaced by
+`FLAGS_ARGV`. See below for more info.
+
+Fixed issue# 7 where long flags defined with '=' (e.g. `--abc=123`) made it
+impossible for the user to know how many non-flag command-line arguments were
+available because the value returned by `FLAGS_ARGC` was wrong. The
+`FLAGS_ARGC` value is now obsolete, but will be maintained for backwards
+compatibility. The new method of getting the non-flag arguments is by executing
+`eval set -- "${FLAGS_ARGV}"` after the `FLAGS` call. The arguments will
+then be available using the standard shell $#, $@, $*, $1, etc. variables.
+
+Due to above fix for issue# 7, there is now proper support for mixing flags
+with non-flag arguments on the command-line. Previously, all non-flag arguments
+had to be at the end of the command-line.
+
+Renamed `_flags_standardGetopt()` and `_flags_enhancedGetopt()` functions to
+`_flags_getoptStandard()` and `_flags_getoptEnhanced()`.
+
+Took out the setting and restoration of the '-u' shell flag to treat unset
+variables as an error. No point in having it in this library as it is verified
+in the unit tests, and provides basically no benefit.
+
+Fixed bug under Solaris where the generated help was adding extra 'x'
+characters.
+
+Added checks for reserved flag variables (e.g. `FLAGS_TRUE`).
+
+Fixed some unset variable bugs.
+
+Now report the actual `getopt` error if there is one.
+
+All tests now properly enable skipping based on whether a standard or enhanced
+`getopt` is found.
+
+Added the OS version to OS release for Solaris.
+
+Fixed `flags_reset()` so it unsets the default value environment vars.
+
+
+Changes with 1.0.2
+------------------
+
+FLAGS_PARENT no longer transforms into a constant so that it can be defined at
+run time in scripts.
+
+Added warning about short flags being unsupported when there are problems
+parsing the options with `getopt`.
+
+Add default values to end of description strings.
+
+Fixed bug that returned an error instead of success when recalling the default
+values for empty strings.
+
+Added warning when a duplicate flag definition is attempted.
+
+Improved `assert[Warn|Error]Msg()` test helper grepping.
+
+Replaced shell_versions.sh with a new versions library and created
+`gen_test_results.sh` to make releases easier.
+
+Copied the coding standards from shUnit2, but haven't fully implemented them
+in shFlags yet.
+
+Issue# 1: When a user defines their own `--help` flag, no more warning is thrown
+when `FLAGS()` is called stating that the help flag already defined.
+
+Issue# 2: Passing the `--nohelp` option no longer gives help output.
+
+Issue# 3: Added support for screen width detection.
+
+
+Changes with 1.0.1
+------------------
+
+Fixed bug where the help output added '[no]' to all flag names
+
+Added additional example files that are referenced by the documentation.
+
+Improved `zsh` version and option checking.
+
+Upgraded shUnit2 to 2.1.4
+
+Added unit testing for the help output.
+
+When including a library (e.g. shflags) in a script, zsh 3.0.8 doesn't actually
+execute the code in-line, but later. As such, variables that are defined in the
+library cannot be used until functions are called from the main code. This
+required the 'help' flag definition to be moved inside the FLAGS command.
+
+
+Changes with 1.0.0
+------------------
+
+This is the first official release, so everything is new.
diff --git a/source/1.0/doc/CHANGES-1.0.txt b/source/1.0/doc/CHANGES-1.0.txt
deleted file mode 100644
index 5a125e6..0000000
--- a/source/1.0/doc/CHANGES-1.0.txt
+++ /dev/null
@@ -1,150 +0,0 @@
-Changes in shFlags 1.0.x
-========================
-
-Changes with 1.0.4
-------------------
-
-Fixed issue #10. Usage of ``expr`` under FreeBSD 7.2 (FreeNAS 0.7.1) and FreeBSD
-8.0 that was causing many unit tests to fail.
-
-Fixed issue where booleans were sometimes mis-configured to require additional
-values like other flags.
-
-Changed _flags_fatal() to exit with FLAGS_ERROR immediately.
-
-Fixed issue #11. When help is requested, the help flag is no longer prefixed
-with [no].
-
-Upgraded shUnit2 to 2.1.6.
-
-Fixed issue #12. Requesting help shouldn't be considered an error.
-
-Added the ability to override the use of the OS default 'getopt' command by
-defining the FLAGS_GETOPT_CMD variable.
-
-Updated gen_test_results.sh and versions from shUnit2 source.
-
-Fixed issues# 13, 14. Added support for dashes ('-') in long flag names. The
-defined flag will still be declared with underscores ('_') due to shell
-limitations, so only one of a dashed flag name or an underscored flag name are
-allowed, not both.
-
-Issue #20. Updated LGPL v2.1 license from
-http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt.
-
-Issue #15. Use ``gexpr`` instead of ``expr`` on BSD variants.
-
-Minor tweaks to make run on FreeBSD 9.1.
-
-Fixed issue in shflags_test_public.sh where screens >80 columns were causing a
-test to fail.
-
-Issue #22. Fixed broken testGetFlagInfo() test.
-
-Created alternate validFloat() and validInt() functions that use shell built-ins
-where possible to increase performance and reduce the usage of the expr command.
-
-Added separate built-in and expr functions for doing math.
-
-
-Changes with 1.0.3
-------------------
-
-MAJOR CHANGE! ``FLAGS_ARGC`` is now obsolete, and is replaced by
-``FLAGS_ARGV``. See below for more info.
-
-Fixed issue# 7 where long flags defined with '=' (e.g. --abc=123) made it
-impossible for the user to know how many non-flag command-line arguments were
-available because the value returned by ``FLAGS_ARGC`` was wrong. The
-``FLAGS_ARGC`` value is now obsolete, but will be maintained for backwards
-compatibility. The new method of getting the non-flag arguments is by executing
-``eval set -- "${FLAGS_ARGV}"`` after the **FLAGS** call. The arguments will
-then be available using the standard shell $#, $@, $*, $1, etc. variables.
-
-Due to above fix for issue# 7, there is now proper support for mixing flags
-with non-flag arguments on the command-line. Previously, all non-flag arguments
-had to be at the end of the command-line.
-
-Renamed ``_flags_standardGetopt()`` and ``_flags_enhancedGetopt()`` functions to
-``_flags_getoptStandard()`` and ``_flags_getoptEnhanced()``.
-
-Took out the setting and restoration of the '-u' shell flag to treat unset
-variables as an error. No point in having it in this library as it is verified
-in the unit tests, and provides basically no benefit.
-
-Fixed bug under Solaris where the generated help was adding extra 'x'
-characters.
-
-Added checks for reserved flag variables (e.g. FLAGS_TRUE).
-
-Fixed some unset variable bugs.
-
-Now report the actual getopt error if there is one.
-
-All tests now properly enable skipping based on whether a standard or enhanced
-getopt is found.
-
-Added the OS version to OS release for Solaris.
-
-Fixed flags_reset() so it unsets the default value environment vars.
-
-
-Changes with 1.0.2
-------------------
-
-FLAGS_PARENT no longer transforms into a constant so that it can be defined at
-run time in scripts.
-
-Added warning about short flags being unsupported when there are problems
-parsing the options with **getopt**.
-
-Add default values to end of description strings.
-
-Fixed bug that returned an error instead of success when recalling the default
-values for empty strings.
-
-Added warning when a duplicate flag definition is attempted.
-
-Improved ``assert[Warn|Error]Msg()`` test helper grepping.
-
-Replaced shell_versions.sh with a new versions library and created
-**gen_test_results.sh** to make releases easier.
-
-Copied the coding standards from shUnit2, but haven't fully implemented them
-in shFlags yet.
-
-Issue# 1: When a user defines their own --help flag, no more warning is thrown
-when FLAGS() is called stating that the help flag already defined.
-
-Issue# 2: Passing the --nohelp option no longer gives help output.
-
-Issue# 3: Added support for screen width detection.
-
-
-Changes with 1.0.1
-------------------
-
-Fixed bug where the help output added [no] to all flag names
-
-Added additional example files that are referenced by the documentation.
-
-Improved zsh version and option checking.
-
-Upgraded shUnit2 to 2.1.4
-
-Added unit testing for the help output.
-
-When including a library (e.g. shflags) in a script, zsh 3.0.8 doesn't actually
-execute the code in-line, but later. As such, variables that are defined in the
-library cannot be used until functions are called from the main code. This
-required the 'help' flag definition to be moved inside the FLAGS command.
-
-
-Changes with 1.0.0
-------------------
-
-This is the first official release, so everything is new.
-
-
-.. vim:fileencoding=latin1:ft=rst:spell:tw=80
-.. $Id$
diff --git a/source/1.0/doc/RELEASE_NOTES-1.0.4.txt b/source/1.0/doc/RELEASE_NOTES-1.0.4.md
similarity index 62%
rename from source/1.0/doc/RELEASE_NOTES-1.0.4.txt
rename to source/1.0/doc/RELEASE_NOTES-1.0.4.md
index 06cca0d..30e75a8 100644
--- a/source/1.0/doc/RELEASE_NOTES-1.0.4.txt
+++ b/source/1.0/doc/RELEASE_NOTES-1.0.4.md
@@ -1,11 +1,10 @@
-------------------------------
-shFlags.sh 1.0.4 Release Notes
-------------------------------
+# shFlags.sh 1.0.4 Release Notes
Preface
=======
+
Copyright 2008-2009 Kate Ward. All Rights Reserved.
-Released under the LGPL (GNU Lesser General Public License)
+Released under the Apache License.
Author: kate.ward@forestent.com (Kate Ward)
This document covers any known issues and workarounds for the stated release of
@@ -16,18 +15,24 @@
This is a minor bug fix release.
-Please see the CHANGES-1.0.txt file for a complete list of changes.
+Please see the `CHANGES-1.0.txt` file for a complete list of changes.
Major changes
-------------
+Changed from the LGPL v2.1 license to the Apache v2.0 license so that others can
+include the library or make changes without needing to release the modified
+source code as well.
+
Obsolete items
--------------
+None
+
Bug fixes
---------
-Issue #10 - Changed the internal usage of the ``expn`` command to fix issues
+Issue #10 - Changed the internal usage of the `expn` command to fix issues
under FreeBSD.
General info
@@ -43,39 +48,34 @@
test is present to verify that shFlags properly caught the limitation and
presented the user with an appropriate error message.
-shFlags tries to support both the standard and enhanced versions of ``getopt``.
+shFlags tries to support both the standard and enhanced versions of `getopt`.
As each responds differently, and not everything is supported on the standard
version, some unit tests will be skipped (i.e. ASSERTS will not be thrown) when
-the standard version of ``getopt`` is detected. The reason being that there is
+the standard version of `getopt` is detected. The reason being that there is
no point testing for functionality that is positively known not to exist. A
tally of skipped tests will be kept for later reference.
Standard vs Enhanced getopt
---------------------------
-Here is a matrix of the supported features of the various **getopt** variants.
+Here is a matrix of the supported features of the various `getopt` variants.
-+=========================================+=====+=====+
| Feature | std | enh |
-+-----------------------------------------+-----+-----+
+|-----------------------------------------|-----|-----|
| short option names | Y | Y |
| long option names | N | Y |
| spaces in string options | N | Y |
| intermixing of flag and non-flag values | N | Y |
-+=========================================+=====+=====+
Known Issues
------------
-The **getopt** version provided by default with all versions of Mac OS X (up to
-and including 10.5.6) and Solaris (up to and including Solaris 10 and
+The `getopt` version provided by default with all versions of Mac OS X (up to
+and including 10.10.2) and Solaris (up to and including Solaris 10 and
OpenSolaris) is the standard version.
Workarounds
-----------
-
-The Zsh shell requires the ``shwordsplit`` option to be set and the special
-``FLAGS_PARENT`` variable must be defined. See ``src/shflags_test_helpers`` to
+The Zsh shell requires the `shwordsplit` option to be set and the special
+`FLAGS_PARENT` variable must be defined. See `src/shflags_test_helpers` to
see how the unit tests do this.
-
-.. vim:fileencoding=latin1:ft=rst:spell:tw=80