Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vverum committed Mar 7, 2021
1 parent 959b97d commit 4cda475
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions Documentation~/Documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation

The **Build Object Remover** allow you to automatically remove a chosen object from a scene from a release build.
The **Build Object Remover** allow you to automatically remove object with selected tag from scenes from a build.

## Overview

Expand All @@ -15,7 +15,7 @@ By default Unity Editor removes objects with tag 'EditorOnly' from build and run

### Adding and removing tags<br/>
1. Adding and removing tags is as simple as pressing the appropriate button.
![Add and remove](AddRemoveTagScreenshot.png)
![Add and remove][AddRemoveImage]
2. Select correct tag from drop-down list with tags in new created row.
3. Enable the row with selected tag.
4. Select correct build type.
Expand All @@ -24,7 +24,7 @@ By default Unity Editor removes objects with tag 'EditorOnly' from build and run
### Seting build type
In `Remove from build types` you are selecting the type of build when the object will be removed.

![Add and remove][AddRemoveImage]
![Add and remove][BuildTypeImage]
* Nothing - does not remove from any runtime or build
* Everything - remove from any runtime or build
* Editor Play Time - remove from play time in editor
Expand Down Expand Up @@ -59,5 +59,6 @@ This project's license is available in the provided "[LICENSE.md](../LICENSE.md)


[ViewImage]: BuildObjRemoverScreenshot.png?raw=true "Tool view in editor"
[AddRemoveImage]: BuildTypeScreenshot.png
[AddRemoveImage]: AddRemoveTagScreenshot.png
[BuildTypeImage]: BuildTypeScreenshot.png
[BuildLogImage]: LogScreenshot.png
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Build Object Remover

The **Build Object Remover** allow you to automatically remove a chosen object from a scene from a release build.
The **Build Object Remover** allow you to automatically remove object with selected tag from scenes from a build.

## Overview

Expand All @@ -25,7 +25,7 @@ https://github.com/vverum/Unity_BuildObjectRemover.git

### Adding and removing tags<br/>
1. Adding and removing tags is as simple as pressing the appropriate button.
![Add and remove](AddRemoveTagScreenshot.png)
![Add and remove][AddRemoveImage]
2. Select correct tag from drop-down list with tags in new created row.
3. Enable the row with selected tag.
4. Select correct build type.
Expand All @@ -34,7 +34,7 @@ https://github.com/vverum/Unity_BuildObjectRemover.git
### Seting build type
In `Remove from build types` you are selecting the type of build when the object will be removed.

![Add and remove][AddRemoveImage]
![Build Types][BuildTypeImage]
* Nothing - does not remove from any runtime or build
* Everything - remove from any runtime or build
* Editor Play Time - remove from play time in editor
Expand Down Expand Up @@ -69,5 +69,6 @@ This project's license is available in the provided "[LICENSE.md](LICENSE.md)" f


[ViewImage]: Documentation~/BuildObjRemoverScreenshot.png?raw=true "Tool view in editor"
[AddRemoveImage]: Documentation~/BuildTypeScreenshot.png
[AddRemoveImage]: Documentation~/AddRemoveTagScreenshot.png
[BuildTypeImage]: Documentation~/BuildTypeScreenshot.png
[BuildLogImage]: Documentation~/LogScreenshot.png

0 comments on commit 4cda475

Please sign in to comment.