Skip to content

Commit 95cd54d

Browse files
committed
Updated readme
1 parent 255388b commit 95cd54d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ A set of C# scripts which simplifies management of human-based experiments devel
55

66
## Get started
77

8-
Import the latest ```.unitypackage``` [release](https://github.com/jackbrookes/unity-experiment-framework/releases) to your existing Unity project.
8+
1. Import the latest ```UXF.unitypackage``` [release](https://github.com/jackbrookes/unity-experiment-framework/releases) to your existing Unity project.
99

10-
Note: Users must change API Compatibility Level to .NET 2.0 in Unity player settings.
10+
2. In Unity, go to `Edit` -> `Player` -> `Other` and change API Compatibility Level to .NET 2.0 in Unity player settings.
1111

1212

1313
## Features
@@ -19,7 +19,7 @@ Note: Users must change API Compatibility Level to .NET 2.0 in Unity player sett
1919

2020
### Data collection
2121

22-
ExpMngr automates the process of collecting behavioural and movement data. **Behavioural data** is collected with 1 row per `Trial`, and automatically records some values such as the timestamp of the start and end of the trial.
22+
UXF automates the process of collecting behavioural and movement data. **Behavioural data** is collected with 1 row per `Trial`, and automatically records some values such as the timestamp of the start and end of the trial.
2323
**Movement data** is the position and rotation of any object in the scene, which is captured at whatever frame rate the application is running at (in the `Update()` loop) by adding a `Tracker` component to a GameObject. This can be used to track positions of user controlled objects (such as hands or head in a virtual reality application) or an arbitrary object in the scene (e.g. some kind of stimuli).
2424
Data is stored in CSV files with automatic handling of file & directory naming.
2525

@@ -54,6 +54,7 @@ UXF classes will be useful in two main parts of your project:
5454
```csharp
5555
class ExperimentBuilder : Monobehaviour
5656
{
57+
5758
// set this to your Session instance in the inspector
5859
public UXF.Session session;
5960

@@ -85,6 +86,7 @@ class ExperimentBuilder : Monobehaviour
8586
```csharp
8687
class SceneManipulator : MonoBehaviour
8788
{
89+
8890
public UXF.Session session;
8991

9092
...
@@ -111,9 +113,7 @@ class SceneManipulator : MonoBehaviour
111113
}
112114
```
113115

114-
115-
See `Assets/ExpMngr/ExampleScript.cs` for another simple example.
116-
116+
More examples are contained in the package.
117117

118118
## Development
119119

0 commit comments

Comments
 (0)