From d0625cad9e4617b8d1be95c93fe1e20acdd7e6b1 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 10 Apr 2020 23:29:34 +0200 Subject: [PATCH 1/4] Cleanup and restructure the README page --- README.md | 46 ++++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 943721f..5d4b544 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# winsw: Windows Service Wrapper in less restrictive license +# WinSW: Windows Service Wrapper in less restrictive license [![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases) [![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/) @@ -13,16 +13,27 @@ Once you download the installation package, you can rename *WinSW.exe* to any na See the [project manifest](MANIFEST.md). +## Supported platforms + +WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1. +It can run on Windows platforms which have these versions of .NET framework installed. +For systems without .NET Framework, the project provides native 64bit and 32bit executables which are based on .NET Core 3.1. + +More executables can be added upon request. + ## Download -Starting from WinSW v2, the releases are being hosted on [GitHub](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/). +WinSW binaries are available on [GitHub Releases](https://github.com/winsw/winsw/releases) and [NuGet](https://www.nuget.org/packages/WinSW/). -Due to historical reasons, the project also uses the [Jenkins](https://jenkins.io/) Maven repository as a secondary source. -Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/). +Alternative sources: + +* [Maven packaging](https://github.com/jenkinsci/winsw-maven-packaging) for executables, hosted by the [Jenkins project](https://jenkins.io/). +Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw/winsw/). +* [Puppet](./doc/puppetWinSW.md), currently outdated (WinSW 1.x). Binaries are available on [Puppet Forge](https://forge.puppet.com/kenmaglio/winsw) ## Usage -WinSW is being managed by configuration files: [Main XML configuration file](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md). +WinSW is being managed by configuration files: [Main XML configuration f,ile](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md). Your renamed *WinSW.exe* binary also accepts the following commands: @@ -38,14 +49,6 @@ Your renamed *WinSW.exe* binary also accepts the following commands: * `Started` to indicate the service is currently running * `Stopped` to indicate that the service is installed but not currently running. -## Supported .NET versions - -### WinSW v2 - -WinSW v2 offers two executables, which declare .NET Frameworks 2.0 and 4.0 as targets. -More executables can be added on-demand. -Please create an issue if you need such executables. - ## Documentation User documentation: @@ -66,20 +69,11 @@ Developer documentation: * [Developer guide](DEVELOPER.md) -## Release lines +## Contributing -### WinSW v2 - -This is a new baseline of WinSW with several major changes: -* Major documentation rework and update -* New executable package targeting the .NET Framework 4.0. .NET Framework 2.0 is still supported. -* [Extension engine](doc/extensions/extensions.md), which allows extending the wrapper's behavior. And a couple of extensions for it (Shared Directory Mapper, Runaway Process Killer) -* New release hosting: GitHub and NuGet -* Migration of the logging subsystem to Apache log4net -* Bugfixes - -The version v2 is **fully compatible** with the v1 configuration file format, - hence the upgrade procedure just requires replacement of the executable file. +Contributions are welcome! +No Clontributor Licence Agreement is needed, just submit your pull requests. +See [the contributor guidelines](./CONTRIBUTING.md) for more information and guidelines. ## License From 51833adc7aec2af21db7f54a88c8ddda81e98246 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 10 Apr 2020 23:32:53 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d4b544..e9c06b1 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Binaries are available [here](https://repo.jenkins-ci.org/releases/com/sun/winsw ## Usage -WinSW is being managed by configuration files: [Main XML configuration f,ile](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md). +WinSW is being managed by configuration files: [Main XML configuration file](doc/xmlConfigFile.md) and [EXE configuration file](doc/exeConfigFile.md). Your renamed *WinSW.exe* binary also accepts the following commands: From 61b1a0fac2c64a3079b4a58d1f5bbdb35eb85813 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Sat, 11 Apr 2020 14:16:52 +0200 Subject: [PATCH 3/4] Apply suggestions from code review by @NextTurn Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e9c06b1..22c98cc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# WinSW: Windows Service Wrapper in less restrictive license +# Windows Service Wrapper in less restrictive license [![Github All Releases](https://img.shields.io/github/downloads/winsw/winsw/total?style=flat-square)](https://github.com/winsw/winsw/releases) [![NuGet](https://img.shields.io/nuget/v/WinSW?style=flat-square)](https://www.nuget.org/packages/WinSW/) @@ -17,7 +17,7 @@ See the [project manifest](MANIFEST.md). WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1. It can run on Windows platforms which have these versions of .NET framework installed. -For systems without .NET Framework, the project provides native 64bit and 32bit executables which are based on .NET Core 3.1. +For systems without .NET Framework, the project provides native 64-bit and 32-bit executables which are based on .NET Core 3.1. More executables can be added upon request. @@ -72,8 +72,8 @@ Developer documentation: ## Contributing Contributions are welcome! -No Clontributor Licence Agreement is needed, just submit your pull requests. -See [the contributor guidelines](./CONTRIBUTING.md) for more information and guidelines. +No Contributor License Agreement is needed, just submit your pull requests. +See the [contributing guidelines](./CONTRIBUTING.md) for more information. ## License From 5720b3b41a72eb7af3740374449938887564d368 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Fri, 17 Apr 2020 08:03:12 +0200 Subject: [PATCH 4/4] Update README.md Co-Authored-By: Next Turn <45985406+NextTurn@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 22c98cc..c1972db 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ See the [project manifest](MANIFEST.md). ## Supported platforms WinSW offers executables for .NET Framework 2.0, 4.0 and 4.6.1. -It can run on Windows platforms which have these versions of .NET framework installed. +It can run on Windows platforms which have these versions of .NET Framework installed. For systems without .NET Framework, the project provides native 64-bit and 32-bit executables which are based on .NET Core 3.1. More executables can be added upon request.