Skip to content

Commit fe02a0f

Browse files
committed
Add package icon and readme
1 parent 6252a43 commit fe02a0f

File tree

3 files changed

+59
-8
lines changed

3 files changed

+59
-8
lines changed

src/DendroDocs.Tool/DendroDocs.Tool.csproj

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
<NeutralLanguage>en-US</NeutralLanguage>
1919
<Version>0.1.0</Version>
2020
<PackageLicenseExpression>MIT</PackageLicenseExpression>
21+
<PackageIcon>icon.png</PackageIcon>
22+
<PackageReadmeFile>README.md</PackageReadmeFile>
2123

2224
<IncludeSymbols>true</IncludeSymbols>
2325
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
@@ -27,14 +29,14 @@
2729
<EmbeddedResource Include="schema.json" />
2830
</ItemGroup>
2931

30-
<ItemGroup>
31-
<Using Include="CommandLine" />
32-
<Using Include="DendroDocs.Extensions" />
33-
<Using Include="DendroDocs.Json" />
34-
<Using Include="Microsoft.CodeAnalysis" />
35-
<Using Include="Microsoft.CodeAnalysis.CSharp" />
36-
<Using Include="Microsoft.CodeAnalysis.CSharp.Syntax" />
37-
</ItemGroup>
32+
<ItemGroup>
33+
<Using Include="CommandLine" />
34+
<Using Include="DendroDocs.Extensions" />
35+
<Using Include="DendroDocs.Json" />
36+
<Using Include="Microsoft.CodeAnalysis" />
37+
<Using Include="Microsoft.CodeAnalysis.CSharp" />
38+
<Using Include="Microsoft.CodeAnalysis.CSharp.Syntax" />
39+
</ItemGroup>
3840

3941
<ItemGroup>
4042
<PackageReference Include="Buildalyzer.Workspaces" />
@@ -46,4 +48,9 @@
4648
<PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" />
4749
</ItemGroup>
4850

51+
<ItemGroup>
52+
<None Update="icon.png" Pack="true" PackagePath="\" />
53+
<None Update="README.md" Pack="true" PackagePath="\" />
54+
</ItemGroup>
55+
4956
</Project>

src/DendroDocs.Tool/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# DendroDocs.Tool
2+
3+
**DendroDocs.Tool** is the successor to the [Living Documentation Analyzer](https://www.nuget.org/packages/LivingDocumentation.Analyzer), providing a solution for analyzing dotnet projects and generating detailed JSON outputs.
4+
This tool is a key component of the DendroDocs ecosystem, designed to bridge the gap between evolving code and up-to-date documentation.
5+
6+
## Features
7+
8+
A command-line tool that analyzes dotnet projects or solutions and produces a JSON file that follows the schema defined in the [DendroDocs Schema](https://github.com/dendrodocs/schema) repository.
9+
10+
## Shared Code
11+
12+
**DendroDocs.Tool** uses the shared library from the [DendroDocs.Shared](https://github.com/dendrodocs/dotnet-shared-lib) repository, ensuring reusability across different parts of the DendroDocs dotnet ecosystem.
13+
14+
## Installation
15+
16+
Install **DendroDocs.Tool** as a dotnet global tool:
17+
18+
```shell
19+
dotnet tool install --global DendroDocs.Tool
20+
```
21+
22+
## Example usage
23+
24+
```shell
25+
dendrodocs-analyze --solution G:\DendroDocs\dotnet-shared-lib\DendroDocs.Shared.sln --output shared.json --pretty --verbose --exclude G:\DendroDocs\dotnet-shared-lib\build\_build.csproj
26+
```
27+
28+
## Output
29+
30+
The output of **DendroDocs.Tool** is a comprehensive JSON file that conforms to the schema defined in the [DendroDocs Schema](https://github.com/dendrodocs/schema).
31+
This JSON file provides a representation of your source code, which can be used to generate various types of documentation or integrate with other tools in your development pipeline.
32+
33+
## The DendroDocs Ecosystem
34+
35+
**DendroDocs.Tool** is part of the broader DendroDocs ecosystem.
36+
Explore [DendroDocs](https://github.com/dendrodocs) to find more tools, libraries, and documentation resources that help you bridge the gap between your code and its documentation.
37+
38+
## Contributing
39+
40+
Contributions are welcome! Please feel free to create [issues](https://github.com/dendrodocs/dotnet-tool/issues) or [pull requests](https://github.com/dendrodocs/dotnet-tool/pulls).
41+
42+
## License
43+
44+
This project is licensed under the MIT License.

src/DendroDocs.Tool/icon.png

15.1 KB
Loading

0 commit comments

Comments
 (0)