From b950b15d53cab2dddc78c65e783ef43042a2e8c9 Mon Sep 17 00:00:00 2001 From: Ben Kuhn Date: Wed, 3 Feb 2021 09:23:14 -0800 Subject: [PATCH] Benkuhn/readme update (#725) * first attempt at update * filling out xlang project list * minor fixes * Update README.md Co-authored-by: Kenny Kerr Co-authored-by: Ben Kuhn Co-authored-by: Kenny Kerr --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4a54b451..abcbf45a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,54 @@ -This repo is the home of the following projects: +## What is xlang? -* Undocked RegFree WinRT -* WinRT ABI Header Generation Tool -* Python/WinRT (experimental) +The xlang project is the hub for the constellation of tools that enable development of Windows applications across a variety of programming languages. This includes tooling to process metadata, and tooling to access APIs from various programming languages including C#, C++, Rust, and Python. -Some of the projects and samples in this repo remain for historical reasons and are not in a usable state. +Code in this repository provides infrastructure and tooling related to basic metadata handling & app usage. Tooling for each language is (mostly) maintained in separate repositories. Issue and work tracking for each tool or language is tracked in the corresponding repository as well. Issues that span languages or relate to basic metadata issues are tracked here. -See these related repos: +### Metadata & Infrastructure + +* [Undocked RegFree WinRT](https://github.com/microsoft/xlang/tree/master/src/UndockedRegFreeWinRT) - Provides access to user-defined WinRT types for versions of Windows prior to Windows 10 May 2019 update. + +* [WinRT test component](https://github.com/microsoft/TestWinRT) - Provides a compact but thorough test suite for validating projection support for consuming and implementing Windows Runtime-style APIs. + +* [Win32 & COM Metadata](https://github.com/microsoft/win32metadata) - Tooling that analyzes Windows C/C++ headers, and provides metadata describing the Win32 & COM API surface of Windows. This metadata is used to provide access to Win32 from other programming languages such as C# & Rust. + +### C++ + +* [C++/WinRT](https://github.com/microsoft/cppwinrt) - A tool that provides C++ support for calling Windows Runtime APIs that has a modern C++ feel. + +* [C++ winmd parser](https://github.com/microsoft/winmd) - A C++ parser library for efficiently parsing WinRT metadata. + +* [WinRT ABI (C with classes) Header Generation Tool ](https://github.com/microsoft/xlang/tree/master/src/tool/abi) - Tool that generates the C++ representation of the raw "COM-style" interfaces that make WinRT work. + +* [C++/Win32](https://github.com/microsoft/cppwin32) - Tooling that leverages the Win32 metadata to provide a modern C++ development experience for Windows APIs. + +* [Windows Implementation Libraries](https://github.com/microsoft/wil) - A set of helper libraries that provide RAII and other helpful abstractions for many existing SDK headers & types. + +### C# + +* [C#/WinRT](https://github.com/microsoft/cswinrt) - Interop support for WinRT APIs and .NET 5. + +* [C#/Win32](https://github.com/microsoft/cswin32) - A metadata-based projection of Win32 and COM APIs. + +### Rust + +* [Rust for Windows](https://github.com/microsoft/windows-rs) - Tooling that creates WinRT, Win32 and COM APIs for the Rust programming language. + +### Python + +* [Python/WinRT (experimental)](https://github.com/microsoft/xlang/tree/master/src/tool/python) - Support for calling most (non-XAML) APIs from the Python programming language. + +### Cross-platform WinRT + +When this repository first created, we used this space to explore what it would take to bring Windows Runtime APIs to other platforms. While that investment has been put on hold for the time being, some of the project code and samples in this repo remain but may be in disrepair. + +## Related projects -* [C++/WinRT](https://github.com/microsoft/cppwinrt) -* [C#/WinRT](https://github.com/microsoft/cswinrt) -* [Rust/WinRT](https://github.com/microsoft/winrt-rs) -* [C++ winmd parser](https://github.com/microsoft/winmd) -* [WinRT test component](https://github.com/microsoft/TestWinRT) * [Project Reunion](https://github.com/microsoft/projectreunion) +* [.NET 5](https://github.com/dotnet) + + ## License Code licensed under the [MIT License](LICENSE). @@ -32,4 +66,3 @@ provided by the bot. You will only need to do this once across all repos using o This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. -