forked from IronLanguages/dlr
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Lamparter <[email protected]>
- Loading branch information
Showing
1 changed file
with
55 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,64 @@ | ||
| Dynamic Language Runtime | ||
| ======================== | ||
| The Dynamic Language Runtime enables language developers to more easily create dynamic languages for the .NET platform. In addition to being a pluggable back-end for dynamic language compilers, the DLR provides language interop for dynamic operations on objects. The DLR has common hosting APIs for using dynamic languages as libraries or for scripting in your .NET applications. | ||
|
|
||
| | **What?** | **Where?** | | ||
| | --------: | :------------: | | ||
| | **Windows/Linux/macOS Builds** | [](https://dotnet.visualstudio.com/IronLanguages/_build/latest?definitionId=41) [](https://github.com/IronLanguages/dlr/actions?workflow=CI) | | ||
| | **Downloads** | [](https://www.nuget.org/packages/DynamicLanguageRuntime/) [](https://github.com/IronLanguages/dlr/releases/latest)| | ||
| | **Help** | [](https://gitter.im/IronLanguages/ironpython) [](http://stackoverflow.com/questions/tagged/dynamic-language-runtime) | | ||
|
|
||
| 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). | ||
| <h1 align="center"> 🌆 Dynamic Language Runtime</h1> | ||
|
|
||
| <p align="center"> | ||
| <a style="text-decoration:none" href="https://github.com/RiversideValley/Dynamic/actions/workflows/ci.yml"> | ||
| <img src="https://github.com/RiversideValley/Dynamic/actions/workflows/ci.yml/badge.svg" alt="CI Status" /></a> | ||
| <!--<a style="text-decoration:none" href="https://nuget.org/packages/Riverside.Dynamic"> | ||
| <img src="https://img.shields.io/nuget/v/Riverside.Dynamic.svg" alt="NuGet" /></a>--> | ||
| <a style="text-decoration:none" href="http://stackoverflow.com/questions/tagged/dynamic-language-runtime"> | ||
| <img src="https://img.shields.io/stackexchange/stackoverflow/t/dynamic-language-runtime?logo=dotnet&label=StackOverflow" alt="Discuss on StackOverflow" /></a> | ||
| </p> | ||
|
|
||
| Introducing the **Dynamic Language Runtime**, an efficient, CLR-friendly language platform that allows developers to create languages that integrate tightly with .NET. | ||
| In addition to being a pluggable back-end for dynamic language compilers, the DLR provides language interop for dynamic operations on objects. The DLR has common hosting APIs for using dynamic languages as libraries or for scripting in your .NET applications. | ||
|
|
||
| ## 🛠️ Building from source | ||
|
|
||
| #### 1. Prerequisites | ||
|
|
||
| - [Visual Studio](https://visualstudio.microsoft.com/vs/) 2019 16.8.0 or later with the following individual components: | ||
| - .NET SDK | ||
| - Git | ||
|
|
||
| #### 2. Clone the repository | ||
|
|
||
| ``` | ||
| git clone https://github.com/RiversideValley/Dynamic | ||
| ``` | ||
|
|
||
| Installation | ||
| ------------ | ||
| The best way to install the DLR is through the NuGet DynamicLanguageRuntime package. | ||
| This will create a local copy of the repository. | ||
|
|
||
| Documentation | ||
| ------------- | ||
| The best current documentation is in the Docs/ directory, in Word and PDF format (it *was* a Microsoft project, after all). | ||
| #### 3. Build the project | ||
|
|
||
| Help | ||
| ---- | ||
| If you have any questions, [open an issue](https://github.com/IronLanguages/dlr/issues/new), even if it's not an actual bug. The issues are an acceptable discussion forum as well. | ||
| To build the DLR for development, open the `Dynamic.sln` item in Visual Studio. Right-click on the `Riverside.Dynamic` project in solution explorer and select ‘Set as Startup item’, then build the project. | ||
|
|
||
| History | ||
| ------- | ||
| The original DLR site is at [CodePlex](http://dlr.codeplex.com). The DLR was part of a much larger repository containing IronPython and IronRuby as well; you can find it at the [main](https://github.com/IronLanguages/main) repository. This is a smaller repository containing just the DLR, which makes it easier to package and should make it easier to do more regular releases. | ||
| > Since the main development is on Windows, cross-platform bugs may inadvertantly be introduced - please report them! | ||
| Build | ||
| ----- | ||
| You will need to have Visual Studio 2019 16.8.0 or later installed on your machine. | ||
| ## ⌛ History of the project | ||
|
|
||
| On Windows machines, start a Visual Studio command prompt and type: | ||
| The original DLR site was available on CodePlex at `dlr.codeplex.com`. The DLR was part of a much larger repository containing IronPython and IronRuby as well; you can find it at the [main](https://github.com/IronLanguages/main) repository (now `IronLanguages/IronRuby` and `IronLanguages/IronPython3`). | ||
| This is a smaller repository containing just the DLR, which makes it easier to package and should make it easier to do more regular releases. | ||
|
|
||
| Since this used to be a Microsoft project, the documentation is written in Microsoft Word format (of course) inside the `Microsoft` directory. | ||
|
|
||
| ## 🙋 Contributing | ||
|
|
||
| There are multiple ways to participate in the community: | ||
|
|
||
| - Upvote popular feature requests | ||
| - [Submit a new feature](https://github.com/RiversideValley/Dynamic/pulls) | ||
| - [File bugs and feature requests](https://github.com/RiversideValley/Dynamic/issues/new/choose). | ||
| - Review source [code changes](https://github.com/RiversideValley/Dynamic/commits) | ||
|
|
||
| We thank all contributors and users for their continued support. | ||
|
|
||
| ### 🤗 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). | ||
|
|
||
| > make | ||
|
|
||
| On Unix machines, make sure Mono is installed and in the PATH, and type: | ||
| ### ⚖️ License | ||
|
|
||
| $ make | ||
| Copyright (c) 2006-2024 .NET Foundation. All Rights Reserved. | ||
|
|
||
| Since the main development is on Windows, Mono bugs may inadvertantly be introduced | ||
| — please report them! | ||
| Licensed under the `Apache-2.0` license as stated in the [LICENSE](https://github.com/RiversideValley/Dynamic/blob/ec74320579aca1d02013d2294253263e848f448b/LICENSE.md). |