|  | 
|  | 1 | +# DendroDocs.Tool | 
|  | 2 | + | 
|  | 3 | +[![Nuget][NUGET_BADGE]][NUGET_FEED] | 
|  | 4 | + | 
|  | 5 | +**DendroDocs.Tool** is the successor to the [Living Documentation](https://github.com/eNeRGy164/LivingDocumentation) Analyzer, providing a solution for analyzing dotnet projects and generating detailed JSON outputs. | 
|  | 6 | +This tool is a key component of the DendroDocs ecosystem, designed to bridge the gap between evolving code and up-to-date documentation. | 
|  | 7 | + | 
|  | 8 | +## Features | 
|  | 9 | + | 
|  | 10 | +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. | 
|  | 11 | + | 
|  | 12 | +## Shared Code | 
|  | 13 | + | 
|  | 14 | +**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. | 
|  | 15 | + | 
|  | 16 | +## Prerequisites | 
|  | 17 | + | 
|  | 18 | +* .NET 8.0 SDK or newer. | 
|  | 19 | + | 
|  | 20 | +## Installation | 
|  | 21 | + | 
|  | 22 | +Install **DendroDocs.Tool** as a dotnet global tool: | 
|  | 23 | + | 
|  | 24 | +```shell | 
|  | 25 | +dotnet tool install --global DendroDocs.Tool | 
|  | 26 | +``` | 
|  | 27 | + | 
|  | 28 | +Example usage: | 
|  | 29 | + | 
|  | 30 | +```shell | 
|  | 31 | +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 | 
|  | 32 | +``` | 
|  | 33 | + | 
|  | 34 | +## Output | 
|  | 35 | + | 
|  | 36 | +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). | 
|  | 37 | +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. | 
|  | 38 | + | 
|  | 39 | +## The DendroDocs Ecosystem | 
|  | 40 | + | 
|  | 41 | +**DendroDocs.Tool** is part of the broader DendroDocs ecosystem. | 
|  | 42 | +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. | 
|  | 43 | + | 
|  | 44 | +## Contributing | 
|  | 45 | + | 
|  | 46 | +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). | 
|  | 47 | + | 
|  | 48 | +## License | 
|  | 49 | + | 
|  | 50 | +This project is licensed under the MIT License. | 
|  | 51 | + | 
|  | 52 | +[NUGET_BADGE]: https://img.shields.io/nuget/v/DendroDocs.Tool.svg?style=plastic | 
|  | 53 | +[NUGET_FEED]: https://www.nuget.org/packages/DendroDocs.Tool/ | 
0 commit comments