From 1d7d8a2f641e7ed8c8fa3e93591661b9429b8651 Mon Sep 17 00:00:00 2001 From: MixeroTN <40803091+MixeroTN@users.noreply.github.com> Date: Wed, 5 Jul 2023 23:23:30 +0000 Subject: [PATCH 1/7] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 90d2ff27d1d7..d6d63e5dd866 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ [![Python package](https://img.shields.io/pypi/v/semantic-kernel)](https://pypi.org/project/semantic-kernel/) [![Nuget package](https://img.shields.io/nuget/vpre/Microsoft.SemanticKernel)](https://www.nuget.org/packages/Microsoft.SemanticKernel/) -[![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) +[![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.yml) +[![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.yml) [![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/blob/main/LICENSE) [![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord) -> ℹ️ **NOTE**:This project is just like AI and will evolve quickly. +> ℹ️ **NOTE**: This project is just like AI and will evolve quickly. > We invite you to join us in developing the Semantic Kernel together! > Please contribute by > using GitHub [Discussions](https://github.com/microsoft/semantic-kernel/discussions), @@ -43,16 +44,28 @@ in the history of computing. Semantic Kernel is available to explore AI and build apps with C# and Python: -
- -Using Semantic Kernel in C#. -
- -
- -Using Semantic Kernel in Python. -
-
+ + + + + + + +
+ + + +
+ Using Semantic Kernel in C#   +
+
+ + + +
+ Using Semantic Kernel in Python +
+
See the [Feature Matrix](FEATURE_MATRIX.md) to see a breakdown of feature parity between C# and Python. @@ -60,14 +73,15 @@ The quickest way to get started with the basics is to get an API key (OpenAI or Azure OpenAI) and to run one of the C# or Python console applications/scripts: -For C#: +### For C#: + 1. Create a new console app. 2. Add the semantic kernel nuget `Microsoft.SemanticKernel`. 3. Copy the code from [here](dotnet/README.md) into the app `Program.cs` file. 4. Replace the configuration placeholders for API key and other params with your key and settings. 5. Run with `F5` or `dotnet run` -For Python: +### For Python: 1. Install the pip package: `python -m pip install semantic-kernel`. 2. Create a new script e.g. `hello-world.py`. 3. Store your API key and settings in an `.env` file as described [here](python/README.md). From b336c03f9185875a670b7c48b06a083d6a1cb5d5 Mon Sep 17 00:00:00 2001 From: MixeroTN <40803091+MixeroTN@users.noreply.github.com> Date: Thu, 6 Jul 2023 09:44:31 +0000 Subject: [PATCH 2/7] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d6d63e5dd866..44be548f1b4b 100644 --- a/README.md +++ b/README.md @@ -49,19 +49,19 @@ Semantic Kernel is available to explore AI and build apps with C# and Python: - +
- Using Semantic Kernel in C#   -
+ Using Semantic Kernel in C#   +
- +
- Using Semantic Kernel in Python -
+ Using Semantic Kernel in Python +
From 2ad1e55750c4dc7910a8511dc88e56147a5fd15e Mon Sep 17 00:00:00 2001 From: MixeroTN <40803091+MixeroTN@users.noreply.github.com> Date: Thu, 6 Jul 2023 09:50:27 +0000 Subject: [PATCH 3/7] Update README.md --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 44be548f1b4b..b35b405d4638 100644 --- a/README.md +++ b/README.md @@ -48,17 +48,13 @@ Semantic Kernel is available to explore AI and build apps with C# and Python: - - - +
Using Semantic Kernel in C#  
- - - +
Using Semantic Kernel in Python
From b33685fa37c6fee1f8fb2513dd2caaa0c28bd7ac Mon Sep 17 00:00:00 2001 From: MixeroTN <40803091+MixeroTN@users.noreply.github.com> Date: Thu, 6 Jul 2023 10:00:04 +0000 Subject: [PATCH 4/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b35b405d4638..93da144c6f55 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ and to run one of the C# or Python console applications/scripts: 5. Run with `F5` or `dotnet run` ### For Python: + 1. Install the pip package: `python -m pip install semantic-kernel`. 2. Create a new script e.g. `hello-world.py`. 3. Store your API key and settings in an `.env` file as described [here](python/README.md). From 4ace2cb5f6926fafe7889f456ddea75f10b9cecc Mon Sep 17 00:00:00 2001 From: MixeroTN <40803091+MixeroTN@users.noreply.github.com> Date: Thu, 6 Jul 2023 10:35:05 +0000 Subject: [PATCH 5/7] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 93da144c6f55..7e94d62f8552 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Python package](https://img.shields.io/pypi/v/semantic-kernel)](https://pypi.org/project/semantic-kernel/) [![Nuget package](https://img.shields.io/nuget/vpre/Microsoft.SemanticKernel)](https://www.nuget.org/packages/Microsoft.SemanticKernel/) -[![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.yml) -[![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.yml) +[![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) +[![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) [![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/blob/main/LICENSE) [![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord) From e10f7a0b468478f962fd1345e7f47cf4579a68ce Mon Sep 17 00:00:00 2001 From: mixeu Date: Thu, 6 Jul 2023 17:43:26 +0200 Subject: [PATCH 6/7] Update README.md Changed table width to 25% --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e94d62f8552..914f7bcb37b6 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ in the history of computing. Semantic Kernel is available to explore AI and build apps with C# and Python: - +
From 85d2f54609beb10c4321c3e26ba81b9be7297428 Mon Sep 17 00:00:00 2001 From: mixeu Date: Thu, 6 Jul 2023 17:49:17 +0200 Subject: [PATCH 7/7] Update README.md Changed table width to 100% --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 914f7bcb37b6..4298994ed035 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ in the history of computing. Semantic Kernel is available to explore AI and build apps with C# and Python: - +