mirrors/winsw
1
0
Fork 0
mirror of https://github.com/winsw/winsw.git synced 2025-12-10 18:37:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation headers

Browse Source
This commit is contained in:
NextTurn
2018-11-28 00:00:00 +08:00
parent e655f5c489
commit 26360ea696
11 changed files with 64 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -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/)
@@ -9,11 +9,11 @@
WinSW is an executable binary, which can be used to wrap and manage a custom process as a Windows service.
Once you download the installation package, you can rename *WinSW.exe* to any name, e.g. *MyService.exe*.
### Why?
## Why?
See the [project manifest](MANIFEST.md).
### Download
## 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/).
@@ -24,14 +24,14 @@ The executables in all sources are [strong-named assemblies](https://msdn.micros
Do not rely on such strong names for security (as well as on other strong names as it recommended by Microsoft).
They provide a unique identity only.
### Usage
## Usage
WinSW is being managed by configuration files: [Main XML Configuration file](doc/xmlConfigFile.md) and [EXE Config 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:
* `install` to install the service to Windows Service Controller.
This command requires some preliminary steps described in the [Installation Guide](doc/installation.md).
This command requires some preliminary steps described in the [Installation guide](doc/installation.md).
* `uninstall` to uninstall the service. The opposite operation of above.
* `start` to start the service. The service must have already been installed.
* `stop` to stop the service.
@@ -42,45 +42,44 @@ 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
## Supported .NET versions
#### WinSW v2
### 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.
#### WinSW v1
### WinSW v1
WinSW v1 Executable is being built with a .NET Framework 2.0 target, and by defaut it will work only for .NET Framework versions below 3.5.
On the other hand, the code is known to be compatible with .NET Framework 4.0 and above.
It is possible to declare the support of this framework via the *.exe.config* file.
See the [Installation Guide](doc/installation.md) for more details.
See the [Installation guide](doc/installation.md) for more details.
### Documentation
## Documentation
User documentation:
* [Installation Guide](doc/installation.md) - Describes the installation process for different systems and .NET versions
* [Release notes](CHANGELOG.md)
* [Installation guide](doc/installation.md) - Describes the installation process for different systems and .NET versions
* Configuration:
* [Main XML Configuration file](doc/xmlConfigFile.md)
* [EXE Configuration File](doc/exeConfigFile.md)
* [Logging and Error Reporting](doc/loggingAndErrorReporting.md)
* [Main XML configuration file](doc/xmlConfigFile.md)
* [EXE configuration file](doc/exeConfigFile.md)
* [Logging and error reporting](doc/loggingAndErrorReporting.md)
* [Extensions](doc/extensions/extensions.md)
* Use-cases:
* [Self-restarting services](doc/selfRestartingService.md)
* [Deferred File Operations](doc/deferredFileOperations.md)
* [Deferred file operations](doc/deferredFileOperations.md)
* Configuration Management:
* [Puppet Forge Module](doc/puppetWinSW.md)
Developer documentation:
* [Developer Guide](DEVELOPER.md)
* [Developer guide](DEVELOPER.md)
### Release lines
## Release lines
#### WinSW v2
### WinSW v2
This is a new baseline of WinSW with several major changes:
* Major documentation rework and update
@@ -95,7 +94,7 @@ See the full changelog in the [release notes](CHANGELOG.md).
The version v2 is **fully compatible** with the v1 configuration file format,
hence the upgrade procedure just requires replacement of the executable file.
#### WinSW v1
### WinSW v1
This is an old baseline of WinSW.
Currently it is in the maintenance-only state.