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

Rename docs for SEO

Browse Source
This commit is contained in:
NextTurn
2020-02-04 00:00:00 +08:00
committed by Next Turn
parent 700f45cb84
commit f43e3bb6ab
20 changed files with 43 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/developer/project-structure.md Normal file
View File

@@ -0,0 +1,45 @@
# Project structure
:movie_camera: You can find the code dive session recorded video [here](https://youtu.be/_adhRj19ESY).
```
|_ docs
|_ eng
|_ samples
|_ src
|_ Core
| |_ ServiceWrapper
| |_ Main.cs
| |_ WinSWCore
| |_ ServiceDescriptor.cs
| |_ Configurations
| |_ Extensions
|_ Plugins
|_ Test/winswTest
```
## :open_file_folder: samples
This folder contains templates for configuration files. *sample-minimal.xml* contains a template for mandatory configurations and *sample-complete.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 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](../../README.md#usage).
## :notebook: WinSWCore
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. 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. The `IWinSWConfiguration.cs` interface contains all configurations and `DefaultSettings.cs` contains default values for the configurations.