github
/
winsw
mirror of https://github.com/winsw/winsw
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #542 from NextTurn/typos 

...
pull/553/head
Oleg Nenashev 2020-06-01 09:51:08 +02:00 committed by GitHub
parent 66167d5251 d086905003
commit 80f109a6a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -29,4 +29,4 @@ dotnet test src\Test\winswTests\winswTests.csproj
## Project Structure
You can find project structure guideline [here.](doc/developer/projectStructure.md)
You can find the project structure guideline [here](doc/developer/projectStructure.md).

16
doc/developer/projectStructure.md
View File

@ -1,6 +1,6 @@
# Project Structure
# Project structure
:movie_camera: [You can find code dive session recorede video here](https://youtu.be/_adhRj19ESY)
:movie_camera: You can find the code dive session recorded video [here](https://youtu.be/_adhRj19ESY).
```
|_ doc
@ -20,26 +20,26 @@
## :open_file_folder: examples
This folder contains templates for configuration files. `sample-minimal.xml` contains a template for mandotory configurations and `sample-allOptions.xml` contains all possible configurations with documentation.
This folder contains templates for configuration files. *sample-minimal.xml* contains a template for mandatory configurations and *sample-allOptions.xml* contains all possible configurations with documentation.
## :open_file_folder: Core
## :notebook: ServiceWrapper
This is the main executable project. This contains the main.cs which is the entry point of the projet and contains some features for logging.
This is the main executable project. This contains the main.cs which is the entry point of the project and contains some features for logging.
### :page_facing_up: Main.cs
This file contains the entry point of the program (Main method). This file includes the main flow of the program and has implemented the logics for command line arguments. You can find more details about command line arguments [here.](https://github.com/winsw/winsw#usage)
This file contains the entry point of the program (Main method). This file includes the main flow of the program and has implemented the logics for command line arguments. You can find more details about command line arguments [here](../../README.md#usage).
## :notebook: WinSWCore
WinSW library is the main component of the project. This contains the most important logics of the project such as ServiceDescriptor.cs, Extension api and configurations etc.
This is the main component of the project. This contains the most important logics of the project such as ServiceDescriptor.cs, Extension api, configurations, etc.
### :page_facing_up: ServiceDescriptor.cs
This contains the logics for extracting configurations from XML file. `ServiceDescriptor` class get XML file as a argument. Currently configuratinos are provided on demand.
This contains the logics for extracting configurations from XML file. The `ServiceDescriptor` class gets XML file as an argument. Currently configuratinos are retrieved on demand.
## :open_file_folder: Configuration
This contains the interface for the configurations. `IWinSWConfiguration.cs` interface contains all configurations and `DefaultSettings.cs` contains default values for the configurations.
This contains the interface for the configurations. The `IWinSWConfiguration.cs` interface contains all configurations and `DefaultSettings.cs` contains default values for the configurations.