Skip to content

Commit b7d9d1e

Browse files
committed
More docs
1 parent 0d1651d commit b7d9d1e

File tree

5 files changed

+14
-6
lines changed

5 files changed

+14
-6
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,25 @@ A release zip has a plugin dll which should be put at Editor folder and
2222
a few compiler related files which should be put at Compiler folder.
2323
Following before and after screenshot will helps for understanding install location.
2424

25-
![InstallScreenshot](./docs/Install.png)
25+
![InstallScreenshot](https://raw.githubusercontent.com/SaladbowlCreative/Unity3D.IncrementalCompiler/master/docs/Install.png)
2626

2727
While an incremental compiler build your scripts, it saves log files to project/Temp
2828
directory. With these log files, you can see how it works.
2929

30-
![LogFiles](./docs/LogFiles.png)
30+
![LogFiles](https://raw.githubusercontent.com/SaladbowlCreative/Unity3D.IncrementalCompiler/master/docs/LogFiles.png)
3131

3232
### Configuration
3333

34-
Basically this compiler works transparently but you can configure subtle details.
35-
Check a configure file which is located at project/Compiler/[IncrementalCompiler.xml](https://github.com/SaladbowlCreative/Unity3D.IncrementalCompiler/blob/master/core/IncrementalCompiler/IncrementalCompiler.xml)
34+
You can configure how this compiler work by settings window.
35+
Click "Assets/Open C# Compiler Settings..." in UnityEditor.
36+
37+
![SettingsMenu](https://raw.githubusercontent.com/SaladbowlCreative/Unity3D.IncrementalCompiler/master/docs/SettingsMenu.png)
38+
39+
Not only settings but you can also check detailed log and information.
40+
41+
![SettingsWindow](https://raw.githubusercontent.com/SaladbowlCreative/Unity3D.IncrementalCompiler/master/docs/SettingsWindow.png)
42+
43+
Also you can manually modify a configure file which is located at project/Compiler/[IncrementalCompiler.xml](https://github.com/SaladbowlCreative/Unity3D.IncrementalCompiler/blob/master/core/IncrementalCompiler/IncrementalCompiler.xml)
3644

3745
### More information
3846

docs/Benchmark.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Benchmark is done with following steps.
2828

2929
1. Unity default compiler (Mono3)
3030
1. C# 6 roslyn compiler (CSC6)
31-
1. Incremental C# 6 Compiler with default configuration (ICS6)
32-
1. Incremental C# 6 Compiler with "WhenNoSourceChange" configuration (ICS6@)
31+
1. Incremental C# 6 Compiler with "WhenNoChange" configuration (ICS6)
32+
1. Incremental C# 6 Compiler with default "WhenNoSourceChange" configuration (ICS6@)
3333

3434
### Results
3535

docs/LogFiles.png

-78 Bytes
Loading

docs/SettingsMenu.png

8.9 KB
Loading

docs/SettingsWindow.png

13.6 KB
Loading

0 commit comments

Comments
 (0)