Skip to content

Commit 90ea7eb

Browse files
committed
More docs
1 parent 709bf3a commit 90ea7eb

File tree

4 files changed

+44
-5
lines changed

4 files changed

+44
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,37 @@ And still now it can support only windows platform.
1212

1313
### Setup
1414

15-
Unzip a release zip file to your Unity project top-most directory.
15+
Unzip [a release zip file](https://github.com/SaladbowlCreative/Unity3D.IncrementalCompiler/releases)
16+
to your unity project top-most directory.
17+
1618
- When Unity 4.x, use IncrementalCompiler.Unity4.zip
1719
- When Unity 5.x, use IncrementalCompiler.Unity5.zip
1820

19-
### Benchmark
21+
A release zip has a plugin dll which should be put at Editor folder and
22+
a few compiler related files which should be put at Compiler folder.
23+
Following before and after screenshot will helps for understanding install location.
24+
25+
![InstallScreenshot](./docs/Install.png)
26+
27+
While an incremental compiler build your scripts, it saves log files to project/Temp
28+
directory. With these log files, you can see how it works.
29+
30+
![LogFiles](./docs/LogFiles.png)
31+
32+
### Configuration
33+
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)
36+
37+
### More information
2038

21-
Brief [Benchmark](./docs/Benchmark.md)
39+
- [Benchmark](./docs/Benchmark.md)
40+
- [Under the hood](./docs/UnderTheHood.md)
2241

2342
### Related works
2443

25-
An integration part between unity3d and incremental compiler is based on
26-
[alexzzzz](https://bitbucket.org/alexzzzz/unity-c-5.0-and-6.0-integration/src)'s works.
44+
- An integration part between unity3d and incremental compiler is based on
45+
[alexzzzz](https://bitbucket.org/alexzzzz/unity-c-5.0-and-6.0-integration/src)'s works.
46+
- Mono MDB writer for roslyn is based on
47+
[marek-safar](https://github.com/marek-safar)'s
48+
[work](https://github.com/mono/roslyn/pull/4).

docs/Install.png

5.73 KB
Loading

docs/LogFiles.png

2.14 KB
Loading

docs/UnderTheHood.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Under the hood
2+
3+
TODO: Write!
4+
5+
### Unity build process
6+
7+
- Assembly-CSharp-firstpass
8+
- Assembly-CSharp
9+
- Assembly-CSharp-Editor
10+
11+
### How to replace a builtin compiler with an incremental one.
12+
13+
TODO: Plugin & UniversalCompiler
14+
15+
### Incremental compiler
16+
17+
TODO: Roslyn, Server, MdbWriter, Reuse DLLs

0 commit comments

Comments
 (0)