doc: update documentation
This commit is contained in:
parent
befd62fbb4
commit
3ee089fb32
41
README.md
41
README.md
@ -1,14 +1,45 @@
|
||||
# Semi.Avalonia
|
||||
|
||||
[](https://www.nuget.org/packages/Semi.Avalonia/)
|
||||
[](https://www.nuget.org/packages/Semi.Avalonia/)
|
||||
|
||||
Avalonia Theme inspired by Semi Design
|
||||
|
||||
> Semi.Avalonia is still in very early stage. Please don't use in production.
|
||||
>
|
||||
> Dark theme is not designed at all. Please don't use that.
|
||||
|
||||

|
||||
# How to Use
|
||||
|
||||
## Requirement
|
||||
## Installation
|
||||
```bash
|
||||
dotnet add package Semi.Avalonia --version 0.1.0-preview5
|
||||
```
|
||||
Include Semi Design Styles in application:
|
||||
|
||||
Avalonia V11
|
||||
```xaml
|
||||
<Application.Styles>
|
||||
<StyleInclude Source="avares://Semi.Avalonia/Themes/DarkTheme.axaml" />
|
||||
</Application.Styles>
|
||||
```
|
||||
|
||||
That's all.
|
||||
|
||||
## Version compatibility
|
||||
|
||||
|Semi Design Version| Avalonia Version|
|
||||
|:---|:---|
|
||||
|0.1.0-preview3|11.0-preview4|
|
||||
|0.1.0-preview5|11.0-preview5|
|
||||
|
||||
## TODO
|
||||
* DataValidationErrors
|
||||
* FocusAdorner
|
||||
* DataGrid
|
||||
* ColorPicker
|
||||
|
||||
## Screenshot
|
||||
|
||||
Light Mode
|
||||

|
||||
|
||||
Dark Mode
|
||||

|
BIN
docs/Dark.png
Normal file
BIN
docs/Dark.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 212 KiB |
BIN
docs/Light.png
Normal file
BIN
docs/Light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 160 KiB |
Loading…
x
Reference in New Issue
Block a user