Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
kekyo committed Mar 6, 2024
1 parent cc2a287 commit 0850aef
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
|Epoxy.Avalonia|[![NuGet Epoxy.Avalonia](https://img.shields.io/nuget/v/Epoxy.Avalonia.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Avalonia)|Avalonia version|
|Epoxy.OpenSilver|[![NuGet Epoxy.OpenSilver](https://img.shields.io/nuget/v/Epoxy.OpenSilver.svg?style=flat)](https://www.nuget.org/packages/Epoxy.OpenSilver)|OpenSilver version|
|Epoxy.Xamarin.Forms|[![NuGet Epoxy.Xamarin.Forms](https://img.shields.io/nuget/v/Epoxy.Xamarin.Forms.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Xamarin.Forms)|Xamarin Forms version|
|Epoxy.Maui|[![NuGet Epoxy.Maui](https://img.shields.io/nuget/v/Epoxy.Maui.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Maui)|.NET MAUI version|

## NuGetパッケージ F#専用

Expand All @@ -38,7 +39,8 @@
* WPF: .NET 8.0/7.0/6.0/5.0, .NET Core 3.0/3.1, .NET Framework 4.5/4.8
* Avalonia: [Avalonia](https://avaloniaui.net/) (New v11 or 0.10 series)
* OpenSilver: [OpenSilver](https://opensilver.net/) (1.0.0 or higher)
* Xamarin Forms: [Xamarin Forms](https://github.com/xamarin/Xamarin.Forms) 5.0.0.1874 or higher)
* Xamarin Forms: [Xamarin Forms](https://github.com/xamarin/Xamarin.Forms) (5.0.0.1874 or higher)
* .NET MAUI: 7.0 or higher
* 非同期処理 (async-await) を安全に書くことが出来るように配慮しています。
* C# 8.0でサポートされた、null許容参照型を使えます。
* F#は5.0以降に対応しています。F#向けのシグネチャ (camel case functions・関数型・Async型前提) が定義されています。
Expand Down Expand Up @@ -69,6 +71,9 @@

### ビルドテンプレートとビルド方法

注意: 将来のバージョンで、テンプレートプロジェクトは廃止されます。
現在のバージョンにおいても、単にあなたのプロジェクトに対応するパッケージを追加するだけで、Epoxyを使用することが出来ます。

.NET 7 SDKのCLIテンプレートに対応しています。以下のようなコマンドで、簡単にテンプレートコードをクリーンな状態で試すことができます:

```bash
Expand Down Expand Up @@ -779,6 +784,11 @@ Apache-v2

## History

* 1.13.0:
* Xamarin Formsがサポート終了となるため、 .NET MAUIパッケージを復活させました (#39)
* 但し、テンプレートプロジェクトは存在しません。あなたのMAUIプロジェクトでEpoxyを使うには、単に `Epoxy.Maui` パッケージを追加すればOKです。
* 同様に、他のプラットフォーム向けのテンプレートプロジェクトも、次のリリースで廃止する予定です。
* Avalonia 11への参照バージョンをダウングレードしました。
* 1.12.0:
* .NET 8.0 SDKに対応しました。
* 1.11.0:
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
|Epoxy.Avalonia|[![NuGet Epoxy.Avalonia](https://img.shields.io/nuget/v/Epoxy.Avalonia.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Avalonia)|Avalonia version|
|Epoxy.OpenSilver|[![NuGet Epoxy.OpenSilver](https://img.shields.io/nuget/v/Epoxy.OpenSilver.svg?style=flat)](https://www.nuget.org/packages/Epoxy.OpenSilver)|OpenSilver version|
|Epoxy.Xamarin.Forms|[![NuGet Epoxy.Xamarin.Forms](https://img.shields.io/nuget/v/Epoxy.Xamarin.Forms.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Xamarin.Forms)|Xamarin Forms version|
|Epoxy.Maui|[![NuGet Epoxy.Maui](https://img.shields.io/nuget/v/Epoxy.Maui.svg?style=flat)](https://www.nuget.org/packages/Epoxy.Maui)|.NET MAUI version|

## NuGet for F# specialized

Expand All @@ -39,6 +40,7 @@
* Avalonia: [Avalonia](https://avaloniaui.net/) (New v11 or 0.10 series)
* OpenSilver: [OpenSilver](https://opensilver.net/) (1.0.0 or higher)
* Xamarin Forms: [Xamarin Forms](https://github.com/xamarin/Xamarin.Forms) (5.0.0.1874 or higher)
* .NET MAUI: 7.0 or higher
* Safe asynchronous operation (async-await) ready.
* C# 8.0 nullable reference types ready.
* F# is 5.0 or upper, F# signatures (camel-case functions, function types, `Async` type assumptions) are defined.
Expand All @@ -61,6 +63,9 @@ or F# sample code in the [playground FSharp directory](playground.FSharp/).

### How to get and build the template code

Note: Template projects will be discontinued in future versions.
You can still use Epoxy in the current version by simply adding the corresponding package to your project.

The .NET 7 SDK CLI template is supported. You can easily try the template code in a clean state with the following command:

```bash
Expand Down Expand Up @@ -780,6 +785,11 @@ Apache-v2

## History

* 1.13.0:
* .NET MAUI package has been resurrected because Xamarin Forms is no longer supported (#39)
* However, there is no template project. To use Epoxy in your MAUI project, simply add the `Epoxy.Maui` package.
* Similarly, template projects for other platforms will be deprecated in the next release.
* Downgraded the reference version to Avalonia 11.
* 1.12.0:
* Supported .NET 8.0 SDK.
* 1.11.0:
Expand Down

0 comments on commit 0850aef

Please sign in to comment.