Another readme generator for .NET.
As you can see, this is a readme generator, it simply do some chores for you.
Usually you'll give some member/type a xml document like <summary>...</summary>, the tool will parse it and combine it with reflection stuff, so you don't have to write an API reference manually.
Feel free to open an issue or make an pull request.
Why it named this?
I don't really know how to name this project, but this is my first attempt at building a useful Avalonia application, a name suchlike "ReadmeGenerator" is too unremarkble, so I name this project "AHpx.RG".
AHpx: me, myself and I.RG: abbreviation for "readme generator.
- Type
- Classes
- Interfaces
- Enums
- Structs
- Delegates
- Members
- Constructors
- Methods
- Fields
- Properties
- Events
### TestLib1
This is test1, basic
#### Constructors
+ Constructor1: this is a constructor
+ ```p1(string)```
+ ```p2(Dicitonatry[int, string])```
#### Methods
+ ```Test1(void)```
+ ```p1(string)```: this is a test parameter 1
#### Fields
+ ```TestField1(string)```: tp4
#### Properties
+ ```TestProperty3(string)```: tp3
### TestLib4
this is test lib4
+ Remark: this is a remark
+ ```T```: this is class-level type argEven though AHpx.RG is a very easy to use tool, but there's an user guide for you.
- Download your OS-corresponded binary from latest release.
- Extract it to any directory you prefer.
- Find the file named "AHpx.RG" and run it as executable.
As I told you before, AHpx.RG is based on reflection and xml summary documentation, so you have to toggled the "Generate XML Documentation" option in the project properties.
When you do as above, you'll see a window like this(it will be automatically turn to dark mode if there's night time). There's 3 text fields in first expander, Compile dll path and Xml documentation path is required, Repository tree link will be used for header of each type if it has also been filled.
Apprently, Compile dll path is the path of the dll you want to generate readme for, and Xml documentation path is the path of the xml documentation file corresponded.
Once you fill the text fields, Types and Previewer expanders will be visible, and you can choose which types you'd like to generator a readme for by checking the checkboxes. Once you choose, the readme will be generated and shown in Previewer instantly.
You can expand the Previewer to see the generated readme, and you can also copy the generated readme to clipboard, that's it, your readme is ready.
If you got an exception which said "xx file not found", try to add the dependencies in Dependency libraries expander, becasue the RG use an AssemblyLoadContext internally, this will load dependencies into this context.
Without them, this project wouldn't be possible:
- Jetbrains: provided free license
- Avalonia: you can see the GUI because of it
- ReactiveUI: a great library for MVVM
- Material.Avalonia: brings RG a gorgeous look
- Markdown.Avalonia: that's why you can have an instant preview
- MessageBox.Avalonia: if you didn't see the message box in RG, you are lucky guy that never got an exception
- Manganese: AHpx's self-made tool library
- Myself: SinoAHpx