Merge pull request lexxmark#36 from GitMensch/GitMensch-patch-1

update to documentation for custom build rules

README.md

@@ -1,26 +1,27 @@
-master [![Build status](https://ci.appveyor.com/api/projects/status/58lcjnr0mb9uc8c8/branch/master?svg=true)](https://ci.appveyor.com/project/lexxmark/winflexbison/branch/master)
+# WinFlexBison - Flex and Bison for Microsoft Windows
 
-bison2.7 [![Build status](https://ci.appveyor.com/api/projects/status/58lcjnr0mb9uc8c8/branch/bison2.7?svg=true)](https://ci.appveyor.com/project/lexxmark/winflexbison/branch/bison2.7)
+WinFlexBison is a Windows port of [Flex (the fast lexical analyser)](https://github.com/westes/flex/) and [GNU Bison (parser generator)](https://www.gnu.org/software/bison/).
+Both win_flex and win_bison are based on upstream sources but depend on system libraries only.
 
-## WinFlexBison - Flex and Bison for Microsoft Windows
+**NOTE**:
+* 2.4.x versions include GNU Bison version 2.7
+* 2.5.x versions include GNU Bison version 3.x.x
 
-Main winflexbison repository for https://sourceforge.net/projects/winflexbison/
+## Build status
+Bison 3.x (master) [![Build status](https://ci.appveyor.com/api/projects/status/58lcjnr0mb9uc8c8/branch/master?svg=true)](https://ci.appveyor.com/project/lexxmark/winflexbison/branch/master) and, for compatibility reasons, Bison 2.7 (bison2.7) [![Build status](https://ci.appveyor.com/api/projects/status/58lcjnr0mb9uc8c8/branch/bison2.7?svg=true)](https://ci.appveyor.com/project/lexxmark/winflexbison/branch/bison2.7)
 
 ## Downloads
-Go to http://sourceforge.net/projects/winflexbison/files/ or https://github.com/lexxmark/winflexbison/releases
+https://github.com/lexxmark/winflexbison/releases provides stable versions. To test non-released development versions see the artifacts provided by CI under "Build status".
 
 ## Changelog
-See the [changelog.md](changelog.md) file.
+The release page includes the full Changelog but you may also see the [changelog.md](changelog.md) file.
 
 ## Build requirements
-  * Visual Studio 2015 or newer
-  * optional: CMake (when building with CMake)
-  * **NOTE**:
-    * 2.4.x versions include bison version 2.7
-    * 2.5.x versions include bison version 3.x.x
+* Visual Studio 2015 or newer
+* optional: CMake (when building with CMake)
 
 ## HowTo
-https://sourceforge.net/p/winflexbison/wiki/Visual%20Studio%20custom%20build%20rules/
+You may use win_flex and win_bison directly on the command line or [use them via CustomBuildRules in VisualStudio](custom_build_rules/docs/VisualStudioCustomBuildRules.md).
 
 ## Example flex/bison files
-Go to https://github.com/meyerd/flex-bison-example
+See https://github.com/meyerd/flex-bison-example

custom_build_rules/docs/VisualStudioCustomBuildRules.md

@@ -10,19 +10,19 @@ You find the custom build rules for win_flex_bison in the **custom_build_rules**
 You may choose to install one of the following rule set
 
 * the combined rules - [alternative download][1]:
-    * [win_flex_bison_custom_build.props  ](win_flex_bison/win_flex_bison_custom_build.props)
-    * [win_flex_bison_custom_build.targets](win_flex_bison/win_flex_bison_custom_build.targets)
-    * [win_flex_bison_custom_build.xml    ](win_flex_bison/win_flex_bison_custom_build.xml)
+    * [win_flex_bison_custom_build.props  ](../win_flex_bison/win_flex_bison_custom_build.props)
+    * [win_flex_bison_custom_build.targets](../win_flex_bison/win_flex_bison_custom_build.targets)
+    * [win_flex_bison_custom_build.xml    ](../win_flex_bison/win_flex_bison_custom_build.xml)
 
 * flex only rules   - [alternative download][2]:
-    * [win_flex_custom_build.props](win_flex_only/win_flex_custom_build.props)
-    * [win_flex_custom_build.targets](win_flex_only/win_flex_custom_build.targets)
-    * [win_flex_custom_build.xml](win_flex_only/win_flex_custom_build.xml)
+    * [win_flex_custom_build.props        ](../win_flex_only/win_flex_custom_build.props)
+    * [win_flex_custom_build.targets      ](../win_flex_only/win_flex_custom_build.targets)
+    * [win_flex_custom_build.xml          ](../win_flex_only/win_flex_custom_build.xml)
 
 * bison only rules  - [alternative download][3]:
-    * [win_bison_custom_build.props](win_bison_only/win_bison_custom_build.props)
-    * [win_bison_custom_build.targets](win_bison_only/win_bison_custom_build.targets)
-    * [win_bison_custom_build.xml](win_bison_only/win_bison_custom_build.xml)
+    * [win_bison_custom_build.props  ](../win_bison_only/win_bison_custom_build.props)
+    * [win_bison_custom_build.targets](../win_bison_only/win_bison_custom_build.targets)
+    * [win_bison_custom_build.xml    ](../win_bison_only/win_bison_custom_build.xml)
 
 This documentation uses the combined rule-set but can be used for all rule-sets.