Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #87

Closed
wants to merge 54 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
c2b98b0
πŸ“– update index files
MorganKryze Feb 19, 2024
f2bd34b
πŸ“– removed future improvements
MorganKryze Feb 19, 2024
86a950c
πŸ“– rename api to references
MorganKryze Feb 19, 2024
210aa38
πŸ€– update dependabot and remove custom template for issues
MorganKryze Feb 19, 2024
6e561c2
πŸ“– too much
MorganKryze Feb 19, 2024
3775c3d
πŸ“– update links
MorganKryze Feb 19, 2024
eaecae1
πŸ“– update references index | update logo and favicon | update assets f…
MorganKryze Feb 20, 2024
ff10a31
πŸ“– add legacy docs
MorganKryze Feb 20, 2024
dec39f2
πŸ“– update create C# docs
MorganKryze Feb 20, 2024
4edc41c
πŸ€– update attributes
MorganKryze Feb 21, 2024
8bcc0b3
πŸ€– issue with argument parsing
MorganKryze Feb 21, 2024
758d602
πŸš‘ same issue
MorganKryze Feb 21, 2024
9a9ab6c
πŸš‘ new try
MorganKryze Feb 21, 2024
c14acd7
πŸš‘ another try
MorganKryze Feb 21, 2024
f3615f2
πŸš‘ specify version
MorganKryze Feb 21, 2024
3d7333e
πŸ“– update publish to github and nuget package
MorganKryze Feb 21, 2024
730eabd
πŸš‘ update built files
MorganKryze Feb 21, 2024
e5f453f
πŸš‘ revert change on csproj
MorganKryze Feb 21, 2024
ebf6878
πŸš‘ slight update
MorganKryze Feb 21, 2024
e9f0664
πŸš‘ add github actions test
MorganKryze Feb 21, 2024
7fb51ec
πŸš‘ moved option to ci
MorganKryze Feb 21, 2024
1ee8559
πŸ“– update publish for this fix
MorganKryze Feb 21, 2024
288d3e0
πŸ“– complete articles index
MorganKryze Feb 21, 2024
7827ad2
πŸ“– try new feature embedded code
MorganKryze Feb 21, 2024
e1fc4d0
πŸš‘ update path
MorganKryze Feb 21, 2024
cab2fbc
πŸ“– finish create elements article
MorganKryze Feb 21, 2024
4232ccc
πŸš‘ quick fix
MorganKryze Feb 21, 2024
1751579
πŸ“– add files and contributing recommendation
MorganKryze Feb 21, 2024
1cbf55b
🌟 new feature AddElement can take multiple elements
MorganKryze Feb 21, 2024
8fcb41b
πŸ“– update intro index
MorganKryze Feb 21, 2024
143fa16
πŸ“– update installation processes
MorganKryze Feb 21, 2024
0ba2d91
πŸš‘ correct video display
MorganKryze Feb 21, 2024
9039d3c
πŸš‘ fix to embed link
MorganKryze Feb 21, 2024
aab2386
πŸš‘ fix embed
MorganKryze Feb 21, 2024
748315c
πŸ“– add new category style
MorganKryze Feb 21, 2024
3990cf2
🌟 try new style on introduction
MorganKryze Feb 21, 2024
5f123ba
πŸ“– update tocs
MorganKryze Feb 21, 2024
eb0fabb
πŸš‘ back to normal
MorganKryze Feb 21, 2024
9a47690
πŸ“– update introduction index.md
MorganKryze Feb 21, 2024
ae34c21
πŸ“– clean empty pages
MorganKryze Feb 21, 2024
1a244df
πŸ“– finish first app tutorial
MorganKryze Feb 22, 2024
cbfa26b
🚧 clean example project
MorganKryze Feb 22, 2024
c2c6372
πŸ“– add install instructions for visual studio
MorganKryze Feb 22, 2024
11273a7
🌟 new elements, improve advanced app add tests
MorganKryze Feb 23, 2024
47489c9
πŸš‘ update lines
MorganKryze Feb 23, 2024
b73d1a0
🚧 removed unused attribute
MorganKryze Feb 23, 2024
e26cdc6
πŸš‘ correct name
MorganKryze Feb 23, 2024
2e72bb2
πŸ“– finish new elements page
MorganKryze Feb 23, 2024
7d58c6b
πŸ“– add menu management
MorganKryze Feb 23, 2024
e265a6d
πŸ“– update
MorganKryze Feb 23, 2024
e80fea8
πŸ“– quick update
MorganKryze Feb 24, 2024
da1352e
πŸ“– add images and gif to docs
MorganKryze Feb 29, 2024
ad5d34b
πŸš‘ upgrade tools
MorganKryze Feb 29, 2024
4e49e1c
πŸ“– slight update of readme
MorganKryze Feb 29, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"isRoot": true,
"tools": {
"csharpier": {
"version": "0.27.2",
"version": "0.27.3",
"commands": [
"dotnet-csharpier"
]
},
"docfx": {
"version": "2.75.2",
"version": "2.75.3",
"commands": [
"docfx"
]
Expand Down
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

4 changes: 3 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ updates:
- package-ecosystem: nuget
directory: /
schedule:
interval: daily
interval: weekly
open-pull-requests-limit: 5
target-branch: dev
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Adding dotnet tools
run: dotnet tool restore
- name: Ensure Coverlet Install
run: dotnet tool install --global coverlet.console
run: dotnet tool install --global coverlet.console --version 6.0.0.0
- name: Install ReportGenerator
run: dotnet tool install --global dotnet-reportgenerator-globaltool
- name: Generate test results using coverlet
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- name: Build
run: dotnet build --configuration Release /p:Version=${VERSION}
- name: Pack
run: dotnet pack src/ConsoleAppVisuals/ConsoleAppVisuals.csproj --configuration Release /p:Version=${VERSION} --no-build --output .
run: dotnet pack src/ConsoleAppVisuals/ConsoleAppVisuals.csproj --configuration Release /p:ContinuousIntegrationBuild=true /p:Version=${VERSION} --no-build --output .
- name: Push to GitHub Packages
run: dotnet nuget push ConsoleAppVisuals.${VERSION}.nupkg --source https://nuget.pkg.github.com/MorganKryze/index.json --api-key ${GITHUB_TOKEN}
env:
Expand Down
48 changes: 27 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@

> User-friendly .NET visuals library designed for console apps

[![version](https://img.shields.io/nuget/v/ConsoleAppVisuals.svg?label=version)](https://www.nuget.org/packages/ConsoleAppVisuals/) [![NuGet](https://img.shields.io/nuget/dt/ConsoleAppVisuals.svg)](https://www.nuget.org/packages/ConsoleAppVisuals/) [![GitHub](https://img.shields.io/github/stars/MorganKryze/consoleappvisuals.svg?style=flat&logo=github&colorB=yellow&label=stars)](https://github.com/MorganKryze/ConsoleAppVisuals) [![Coverage Status](https://coveralls.io/repos/github/MorganKryze/ConsoleAppVisuals/badge.svg)](https://coveralls.io/github/MorganKryze/ConsoleAppVisuals?branch=main) [![License: GNU GPL](https://img.shields.io/badge/License-GNU_GPL-orange.svg)](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/LICENSE)
[![version](https://img.shields.io/nuget/v/ConsoleAppVisuals.svg?label=version)](https://www.nuget.org/packages/ConsoleAppVisuals/) [![NuGet](https://img.shields.io/nuget/dt/ConsoleAppVisuals.svg)](https://www.nuget.org/packages/ConsoleAppVisuals/) [![GitHub](https://img.shields.io/github/stars/MorganKryze/consoleappvisuals.svg?style=flat&logo=github&colorB=yellow&label=stars)](https://github.com/MorganKryze/ConsoleAppVisuals) [![Coverage Status](https://coveralls.io/repos/github/MorganKryze/ConsoleAppVisuals/badge.svg?)](https://coveralls.io/github/MorganKryze/ConsoleAppVisuals?branch=main) [![License: GNU GPL](https://img.shields.io/badge/License-GNU_GPL-orange.svg)](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/LICENSE)

![title](docs/images/presentation.gif)
![title](docs/assets/vid/gif/presentation.gif)

## Documentation

Feel free to check out the following resources to help you get started:

- Take a quick look at our [example project](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/example/Program.cs) to understand how to implement the library in your own project
- A [complete documentation](https://morgankryze.github.io/ConsoleAppVisuals/) is also available.

## Install

Expand All @@ -14,7 +21,9 @@ Install the library using the .NET CLI:
dotnet add package ConsoleAppVisuals
```

Or for Visual Studio users, you can install the library using the NuGet Package Manager:
Install the library for Visual Studio users, go through [this tutorial](https://www.youtube.com/watch?v=IprbRazS3b8).

Or Enter the following command in the Package Manager Console in Visual Studio:

```bash
Install-Package ConsoleAppVisuals
Expand Down Expand Up @@ -49,7 +58,7 @@ using ConsoleAppVisuals;
The first step is to create an element to display. For example, let's create a `Title` element:

```csharp
Title exampleTitle = new Title("Hello, world!");
Title exampleTitle = new Title("Hello world!");
```

Then, you can add it to `Window`:
Expand All @@ -61,7 +70,7 @@ Window.AddElement(exampleTitle);
Finally, you can display the `Window`:

```csharp
Window.Refresh();
Window.Render();
```

Now at each refresh, the `Title` element will appear on screen. To disable it, you may choose one of these options:
Expand Down Expand Up @@ -99,7 +108,7 @@ Finally, you can display the `Window`, remember that interactive element are dis

```csharp
// Add this line if you have static elements to display
Window.Refresh();
Window.Render();

Window.ActivateElement<Prompt>();
```
Expand Down Expand Up @@ -129,31 +138,24 @@ You may now remove the element from the list if you want to:
Window.RemoveElement<Prompt>();
```

## Documentation

Feel free to check out the following resources to help you get started:

- Take a quick look at our [example project](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/example/Program.cs) to understand how to implement the library in your own project
- A [complete documentation](https://morgankryze.github.io/ConsoleAppVisuals/) is also available.

## Roadmap

The library is still in development and we are working on the following features:

- [x] Add a new visual: the `TableSelector`
- [ ] Add colorization to `TableSelector` (highligth data according to a condition)
- [ ] Add colorization to `TableSelector` (highlight data according to a condition)
- [ ] Add example of a custom font in the example project
- [ ] Add more default fonts
- [ ] Add a new visual: the `Chart`

### Supported dotnet versions
## Supported .NET versions

| Version | Supported |
| ------- | ------------------ |
| 8.x | :white_check_mark: |
| 7.x | :white_check_mark: |
| 6.x | :white_check_mark: |
| < 6.x | :x: |
| Version | Supported |
| -------- | ------------------ |
| net8.x | :white_check_mark: |
| net7.x | :white_check_mark: |
| net6.x | :white_check_mark: |
| < net6.x | :x: |

## Security Policy

Expand All @@ -168,6 +170,10 @@ Consider reading our [security policy](SECURITY.md) to know more about how we ha

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. To do so, follow the steps described in the [CONTRIBUTING](CONTRIBUTING.md) file.

We are always open for feedback and discussions. If you are using our library and want to share your use case, or if you have any suggestions for improvement, please feel free to [open an issue](https://github.com/MorganKryze/ConsoleAppVisuals/issues) or [open a discussion](https://github.com/MorganKryze/ConsoleAppVisuals/discussions) on our GitHub repository. Your input helps us understand possible use cases and make necessary improvements.

Do not hesitate to star and share the project if you like it!

## License

Distributed under the GNU GPL v3.0 License. See [`LICENSE`](https://github.com/MorganKryze/ConsoleAppVisuals/blob/main/LICENSE) for more information.
57 changes: 0 additions & 57 deletions docs/api/index.md

This file was deleted.

Loading
Loading