Skip to content

Commit

Permalink
Updating READMEs and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Keboo committed Oct 7, 2024
1 parent a868177 commit 635170a
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 12 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ dotnet new uninstall Keboo.Dotnet.Templates
```

## Included Templates
- [Avalonia Solution](./templates/Avalonia/AvaloniaSolution/README.md)
- [WPF Solution](./templates/WPF/WpfApp/README.md)
- [NuGet Package Solution](./templates/Library/NuGet/README.md)
- [System.CommandLine Solution](./templates/Console/ConsoleApp/README.md)
Expand Down
27 changes: 27 additions & 0 deletions templates/Avalonia/AvaloniaSolution/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Avalonia solution template
This template creates a solution with all needed projects for an [Avalonia UI project](https://avaloniaui.net/).


## Template
Create a new app in your current directory by running.

```cli
> dotnet new keboo.avalonia
```

### Parameters
[Default template options](https://learn.microsoft.com/dotnet/core/tools/dotnet-new#options)

## Key Features

### Build Customization
[Docs](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory?view=vs-2022&WT.mc_id=DT-MVP-5003472)

### Centralized Package Management
[Docs](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management?WT.mc_id=DT-MVP-5003472)

### CommunityToolkit MVVM
[Docs](https://learn.microsoft.com/dotnet/communitytoolkit/mvvm/?WT.mc_id=DT-MVP-5003472)

### NuGet package source mapping
[Docs](https://learn.microsoft.com/nuget/consume-packages/package-source-mapping?WT.mc_id=DT-MVP-5003472)
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
x:Class="SampleAvaloniaApplication.Views.MainView"
x:DataType="vm:MainViewModel">
<Design.DataContext>
<!-- This only sets the DataContext for the previewer in an IDE,
to set the actual DataContext for runtime, set the DataContext property in code (look at App.axaml.cs) -->
<!--
This only sets the DataContext for the previewer in an IDE.
The actual setting of the DataContext is done in the code-behind with an overloaded constructor.
-->
<vm:MainViewModel />
</Design.DataContext>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ namespace SampleAvaloniaApplication.Views;

public partial class MainView : UserControl
{
// This constructor is used when the view is created by the XAML Previewer
public MainView()
{
InitializeComponent();
}

// This constructor is used when the view is created via dependency injection
public MainView(MainViewModel viewModel)
: this()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ namespace SampleAvaloniaApplication.Views;

public partial class MainWindow : Window
{
// This constructor is used when the view is created by the XAML Previewer
public MainWindow()
{
InitializeComponent();
}

// This constructor is used when the view is created via dependency injection
public MainWindow(MainView mainView)
: this()
{
Expand Down
10 changes: 9 additions & 1 deletion templates/Console/ConsoleApp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,12 @@ Create a new app in your current directory by running.
[Default template options](https://learn.microsoft.com/dotnet/core/tools/dotnet-new#options)

## Key Features
*TODO*

### Build Customization
[Docs](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory?view=vs-2022&WT.mc_id=DT-MVP-5003472)

### Centralized Package Management
[Docs](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management?WT.mc_id=DT-MVP-5003472)

### NuGet package source mapping
[Docs](https://learn.microsoft.com/nuget/consume-packages/package-source-mapping?WT.mc_id=DT-MVP-5003472)
10 changes: 9 additions & 1 deletion templates/Library/NuGet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,12 @@ Create a new app in your current directory by running.
[Default template options](https://learn.microsoft.com/dotnet/core/tools/dotnet-new#options)

## Key Features
*TODO*

### Build Customization
[Docs](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory?view=vs-2022&WT.mc_id=DT-MVP-5003472)

### Centralized Package Management
[Docs](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management?WT.mc_id=DT-MVP-5003472)

### NuGet package source mapping
[Docs](https://learn.microsoft.com/nuget/consume-packages/package-source-mapping?WT.mc_id=DT-MVP-5003472)
29 changes: 21 additions & 8 deletions templates/WPF/WpfApp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,35 @@ Create a new app in your current directory by running.
## Key Features

### Generic Host Dependency Injection
*TODO*
[Docs](https://learn.microsoft.com/dotnet/core/extensions/generic-host?tabs=appbuilder&WT.mc_id=DT-MVP-5003472)

### CEntralized Package Management
*TODO*
### Centralized Package Management
[Docs](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management?WT.mc_id=DT-MVP-5003472)

### Build Customization
*TODO*
[Docs](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory?view=vs-2022&WT.mc_id=DT-MVP-5003472)

### CommunityToolkit MVVM
*TODO*
[Docs](https://learn.microsoft.com/dotnet/communitytoolkit/mvvm/?WT.mc_id=DT-MVP-5003472)

### Material Design in XAML
*TODO*
[Repo](https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit)

### .editorconfig formatting
*TODO*
[Docs](https://learn.microsoft.com/dotnet/fundamentals/code-analysis/code-style-rule-options?WT.mc_id=DT-MVP-5003472)

### Testing with Moq.AutoMocker
*TODO*
[Repo](https://github.com/moq/Moq.AutoMocker)

### NuGet package source mapping
[Docs](https://learn.microsoft.com/nuget/consume-packages/package-source-mapping?WT.mc_id=DT-MVP-5003472)

### Dependabot auto updating of dependencies
[Docs](https://docs.github.com/code-security/dependabot/dependabot-version-updates)
Auto merging of these PRs done with [fastify/github-action-merge-dependabot](https://github.com/fastify/github-action-merge-dependabot).

### GitHub Actions workflow with code coverage reporting
[Docs](https://docs.github.com/actions).
Code coverage provided by [coverlet-coverage/coverlet](https://github.com/coverlet-coverage/coverlet).
Code coverage report provided by [danielpalme/ReportGenerator-GitHub-Action](https://github.com/danielpalme/ReportGenerator-GitHub-Action).
The coverage reports are posted as "stciky" PR comments provided by [marocchino/sticky-pull-request-comment](https://github.com/marocchino/sticky-pull-request-comment)

0 comments on commit 635170a

Please sign in to comment.