Skip to content

Commit

Permalink
Improve sections in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lamparter authored Nov 17, 2024
1 parent 35d0f65 commit e43cf2d
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ IronPython is an open-source implementation of the Python programming language t

IronPython 3 targets Python 3, including the re-organized standard library, Unicode strings, and all of the other new features.

## 🎁 Installation

Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython). See the [installation article](https://github.com/IronLanguages/ironpython3/wiki/Installing) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.

## ✍️ Examples

The following C# program:
Expand Down Expand Up @@ -58,10 +62,6 @@ System.Console.WriteLine(greetings("world"));

> This example assumes that `IronPython` has been added to the C# project as a NuGet package.
## ⚖️ Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).

## 🐍 State of the Project

The current target is Python 3.4, although features and behaviors from later versions may be included.
Expand All @@ -77,22 +77,23 @@ See the following lists for features from each version of CPython that have been
- [`Python3.6`](https://github.com/IronLanguages/ironpython3/wiki/WhatsNew%E2%80%90Python3.6)

## 🙋 Contributing
For details on contributing see the [Contributing](CONTRIBUTING.md) article.

## ⬆️ Upgrading from IronPython 2
For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](https://github.com/IronLanguages/ironpython3/wiki/Upgrading-from-IronPython2) article.
Want to contribute to this project? Let us know with an [issue](https://github.com/IronLanguages/IronPython3/issues) that communicates your intent to create a [pull request](https://github.com/IronLanguages/IronPython3/pulls). Also, view our [contributing guidelines](CONTRIBUTING.md) to make sure you're up to date on the coding conventions.
For more details on contributing see the [Contributing](CONTRIBUTING.md) article.

## 🧭 Differences with CPython
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
#### 🫡 Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).

## 📦 Package compatibility
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular packages.
### 🛠️ Building from source

## 🎁 Installation
Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](https://github.com/IronLanguages/ironpython3/wiki/Installing) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
See the article on [building from source](https://github.com/IronLanguages/ironpython3/wiki/Building). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!

### ⚖️ License

This project is licensed under the Apache-2.0 License as stated in the [`LICENSE`](https://github.com/IronLanguages/ironpython3/blob/56d1799/LICENSE).
> Copyright (c) .NET Foundation and Contributors.
## 🛠️ Build
See the [building document](https://github.com/IronLanguages/ironpython3/wiki/Building). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
### 📝 Wiki

## Supported Platforms
IronPython 3 targets .NET Framework 4.6.2, .NET Standard 2.0 and .NET 6.0. The support for .NET and .NET Core follow the lifecycle defined on [.NET and .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core).
The documentation and guides for IronPython are available [on the wiki](https://github.com/IronLanguages/ironpython3/wiki). Enjoy!

0 comments on commit e43cf2d

Please sign in to comment.