Skip to content

Commit 9e59115

Browse files
committed
docs: update readme
1 parent e0992ac commit 9e59115

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Change the C# compiler (csc) used on your Unity project, as you like!
1010
![](https://img.shields.io/badge/Unity%202018.3%20or%20later-supported-blue.svg)
1111
![](https://img.shields.io/badge/Unity%202019.x-supported-blue.svg)
1212
![](https://img.shields.io/badge/Unity%202020.x-supported-blue.svg)
13+
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mob-sakai/CSharpCompilerSettingsForUnity/unity-test)
1314
[![Test](https://mob-sakai.testspace.com/spaces/130862/badge?token=43a50d2fc998aa362d36934597de0c84527e5690)](https://mob-sakai.testspace.com/spaces/130862)
1415
[![CodeCoverage](https://mob-sakai.testspace.com/spaces/130862/metrics/99758/badge)](https://mob-sakai.testspace.com/spaces/130862/current/Code%20Coverage/Code%20Coverage")
15-
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mob-sakai/CSharpCompilerSettingsForUnity/unity-test)
1616

1717
<< [Description](#description) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) >>
1818

@@ -51,8 +51,8 @@ However, unfortunately, [there are no plans to backport to Unity 2020.1 or earli
5151
This package changes the C# compiler (csc) used on your Unity project, to support C# 8.0.
5252
Let's enjoy C# 8.0 features with your Unity project!
5353

54-
![](https://user-images.githubusercontent.com/12690315/95178488-7456dc00-07fa-11eb-8489-63d6af311ed0.png)
55-
![](https://user-images.githubusercontent.com/12690315/95178483-728d1880-07fa-11eb-89e6-c29d98e2ab02.png)
54+
![](https://user-images.githubusercontent.com/12690315/97001486-62ec2e80-1573-11eb-9003-d40eb8ed8904.png)
55+
![](https://user-images.githubusercontent.com/12690315/97001169-e3f6f600-1572-11eb-8504-c528130c2234.png)
5656

5757
### Features
5858

@@ -95,7 +95,15 @@ Let's enjoy C# 8.0 features with your Unity project!
9595
* If `dotnet` is required, install it automatically.
9696
* `CompilerType.BuiltIn` compiler option to disable this plugin.
9797
* `Enable Logging` option to display compilation log.
98-
* `Allow Nullable` option to enable [Nullable reference types (C# 8.0)](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/nullable-reference-types).
98+
* `Nullable` option to enable [Nullable reference types (C# 8.0)](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/nullable-reference-types).
99+
* `enable`: The nullable annotation context is enabled. The nullable warning context is enabled.
100+
* Variables of a reference type, string for example, are non-nullable. All nullability warnings are enabled.
101+
* `warnings`: The nullable annotation context is disabled. The nullable warning context is enabled.
102+
* Variables of a reference type are oblivious. All nullability warnings are enabled.
103+
* `annotations`: The nullable annotation context is enabled. The nullable warning context is disabled.
104+
* Variables of a reference type, string for example, are non-nullable. All nullability warnings are disabled.
105+
* `disable`: The nullable annotation context is disabled. The nullable warning context is disabled.
106+
* Variables of a reference type are oblivious, just like earlier versions of C#. All nullability warnings are disabled.
99107

100108
[OpenSesame.Net.Compilers]: https://www.nuget.org/packages/OpenSesame.Net.Compilers
101109
[OpenSesame.Net.Compilers.Toolset]: https://www.nuget.org/packages/OpenSesame.Net.Compilers.Toolset
@@ -158,11 +166,11 @@ Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to insta
158166
![](https://user-images.githubusercontent.com/12690315/92742741-e3d3da00-f3ba-11ea-8314-4cabd88c1b2c.png)
159167
2. Select `C# Compiler` tab
160168
3. Set `Compiler Type` to `Custom Package`, to use custom compiler package.
161-
![](https://user-images.githubusercontent.com/12690315/95178488-7456dc00-07fa-11eb-8489-63d6af311ed0.png)
162-
3. Input `Package Name`, `Package Version`, `Language Version` for compilation.
169+
![](https://user-images.githubusercontent.com/12690315/97001486-62ec2e80-1573-11eb-9003-d40eb8ed8904.png)
170+
1. Input `Package Name`, `Package Version`, `Language Version` for compilation.
163171
* See [features](#features) section.
164-
4. Press `Apply` button to save settings.
165-
5. It will automatically request a recompilation.
172+
2. Press `Apply` button to save settings.
173+
3. It will automatically request a recompilation.
166174
The selected nuget package will be used for compilation.
167175
6. Enjoy!
168176

@@ -187,7 +195,7 @@ The project setting asset for C# Compiler will be saved in `ProjectSettings/CSha
187195

188196
1. Select a `*.asmodef` file
189197
2. Turn on `Enable C# Compilier Settings` to configure.
190-
![](https://user-images.githubusercontent.com/12690315/95178483-728d1880-07fa-11eb-89e6-c29d98e2ab02.png)
198+
![](https://user-images.githubusercontent.com/12690315/97001169-e3f6f600-1572-11eb-8504-c528130c2234.png)
191199
3. Set `Compiler Type` to `Custom Package`, to use custom compiler package.
192200
4. Input `Package Name`, `Package Version`, `Language Version` and `Modify Symbols` for compilation.
193201
* See [features](#features) section.
@@ -271,8 +279,7 @@ With your support, I can spend more time on development. :)
271279

272280
## Author
273281

274-
* [mob-sakai](https://github.com/mob-sakai) [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) ![GitHub followers](https://img.shields.io/github/followers/mob-sakai?style=social)
275-
![](https://user-images.githubusercontent.com/12690315/96912074-bcede500-14dc-11eb-8acd-3fdd8d0e4606.png)
282+
* ![](https://user-images.githubusercontent.com/12690315/96986908-434a0b80-155d-11eb-8275-85138ab90afa.png) [mob-sakai](https://github.com/mob-sakai) [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) ![GitHub followers](https://img.shields.io/github/followers/mob-sakai?style=social)
276283

277284
## See Also
278285

0 commit comments

Comments
 (0)