Skip to content

Commit 69fb411

Browse files
authored
Improve README.md (#1870)
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> `README.md` had several visual problems, which I decided to fix. ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> - The first problem was a `dotnet-ci` status badge, which is no longer available. I replaced it with two status badges: `dotnet-ci-docker` and `dotnet-ci-windows`. - The second one was *Using Semantic Kernel in C# and Python*. The icons were positioned out of place. I have made a small table with the icons and hyperlinks present earlier. - And finally, small corrections such as h3 lines for C# and Python approaches above *getting started with the basics* instructions. ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows SK Contribution Guidelines (https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) - [x] The code follows the .NET coding conventions (https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions) verified with `dotnet format` - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄
1 parent 5b35b4b commit 69fb411

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
[![Python package](https://img.shields.io/pypi/v/semantic-kernel)](https://pypi.org/project/semantic-kernel/)
44
[![Nuget package](https://img.shields.io/nuget/vpre/Microsoft.SemanticKernel)](https://www.nuget.org/packages/Microsoft.SemanticKernel/)
5-
[![dotnet](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci.yml/badge.svg?branch=main)](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci.yml)
5+
[![dotnet Docker](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci-docker.yml/badge.svg?branch=main)](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci-docker.yml)
6+
[![dotnet Windows](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci-windows.yml/badge.svg?branch=main)](https://github.com/microsoft/semantic-kernel/actions/workflows/dotnet-ci-windows.yml)
67
[![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/blob/main/LICENSE)
78
[![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord)
89

9-
> ℹ️ **NOTE**:This project is just like AI and will evolve quickly.
10+
> ℹ️ **NOTE**: This project is just like AI and will evolve quickly.
1011
> We invite you to join us in developing the Semantic Kernel together!
1112
> Please contribute by
1213
> using GitHub [Discussions](https://github.com/microsoft/semantic-kernel/discussions),
@@ -43,31 +44,41 @@ in the history of computing.
4344

4445
Semantic Kernel is available to explore AI and build apps with C# and Python:
4546

46-
<div style="display:flex;height:30px;padding:5px 0 5px 10px;">
47-
<img src="https://user-images.githubusercontent.com/371009/230673036-fad1e8e6-5d48-49b1-a9c1-6f9834e0d165.png" style="margin-right:12px" height="30"/>
48-
<a href="dotnet/README.md">Using Semantic Kernel in C#</a>.
49-
</div>
50-
51-
<div style="display:flex;height:30px;padding:5px 0 5px 10px;">
52-
<img src="https://user-images.githubusercontent.com/371009/230673733-7a447d30-b48e-46e1-bd84-2b321c90649e.png" style="margin-right:12px" height="30"/>
53-
<a href="python/README.md">Using Semantic Kernel in Python</a>.
54-
</div>
55-
<br/>
47+
<table width=100%>
48+
<tbody>
49+
<tr>
50+
<td>
51+
<img align="left" width=52px src="https://user-images.githubusercontent.com/371009/230673036-fad1e8e6-5d48-49b1-a9c1-6f9834e0d165.png">
52+
<div>
53+
<a href="dotnet/README.md">Using Semantic Kernel in C#</a> &nbsp
54+
</div>
55+
</td>
56+
<td>
57+
<img align="left" width=52px src="https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg">
58+
<div>
59+
<a href="python/README.md">Using Semantic Kernel in Python</a>
60+
</div>
61+
</td>
62+
</tr>
63+
</tbody>
64+
</table>
5665

5766
See the [Feature Matrix](FEATURE_MATRIX.md) to see a breakdown of feature parity between C# and Python.
5867

5968
The quickest way to get started with the basics is to get an API key
6069
(OpenAI or Azure OpenAI)
6170
and to run one of the C# or Python console applications/scripts:
6271

63-
For C#:
72+
### For C#:
73+
6474
1. Create a new console app.
6575
2. Add the semantic kernel nuget `Microsoft.SemanticKernel`.
6676
3. Copy the code from [here](dotnet/README.md) into the app `Program.cs` file.
6777
4. Replace the configuration placeholders for API key and other params with your key and settings.
6878
5. Run with `F5` or `dotnet run`
6979

70-
For Python:
80+
### For Python:
81+
7182
1. Install the pip package: `python -m pip install semantic-kernel`.
7283
2. Create a new script e.g. `hello-world.py`.
7384
3. Store your API key and settings in an `.env` file as described [here](python/README.md).

0 commit comments

Comments
 (0)