Skip to content

Commit 4d95ad8

Browse files
authored
Update README-WINDOWS.md
1 parent 29c3a49 commit 4d95ad8

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README-WINDOWS.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,33 @@ This readme contains information specific to Window 10. For general information,
44

55
## Building
66

7-
Example for setting up `ros2cs` standalone with `Unity` editor on Windows (powershell with git). Let's assume working directory is `C:\dev` and we are using `ROS2 foxy`.
7+
We assume working directory is `C:\dev` and we are using `ROS2 foxy` (replace with `Galactic` where applicable).
88

99
### Prerequisites
1010

11-
To prepare your machine for `ROS2 For Unity` build please follow step by step the `ros2cs` [Prequisites](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#prequisites) and [Important notices](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices) sections.
12-
Prepairing environment with `ros2cs` instruction is ***crucial*** for failure-free Unity Asset generation.
13-
14-
**Ommitting any of the steps mentioned above will result in a build failure!**
11+
It is necessary to complete all the steps for `ros2cs` [Prequisites](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#prequisites) and consider [Important notices](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices) sections.
1512

1613
### Steps
1714

1815
* Make sure [long paths on Windows are enabled](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices)
19-
* Please open [`Developer PowerShell for VS` with administrator privileges](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices)
20-
* When using `ros2 galactic` distribution, for simplicity's's sake please [create a `C:\ci\ws\install\include` directory](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices)
16+
* Make sure you open [`Developer PowerShell for VS` with administrator privileges](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices)
17+
* For `ros2 galactic` distribution, it is best to [create a `C:\ci\ws\install\include` directory](https://github.com/RobotecAI/ros2cs/blob/master/README-WINDOWS.md#important-notices)
2118
* Clone this repository.
22-
* You need to source your ROS2 installation (`C:\dev\ros2_foxy\local_setup.ps1`) before you proceed, for each new terminal.
23-
* Run `pull_repositories.ps1`. This will pull `ros2cs` as well as your custom messages. You will be asked for github credentials, so please fill your information.
19+
* Source your ROS2 installation (`C:\dev\ros2_foxy\local_setup.ps1`) in the terminal before you proceed.
20+
* Run `pull_repositories.ps1`. This will pull `ros2cs` as well as your custom messages. You might be asked for github credentials.
2421
* Run `build.ps1` script.
25-
* You can build tests by adding `--with-tests` argument to `build` command.
26-
* It invokes `colcon_build` with `--merge-install` argument to simplify libraries installation.
22+
* Optionally, you can build tests by adding `--with-tests` argument to `build` command.
23+
* This ivokes `colcon_build` with `--merge-install` argument to simplify libraries installation.
2724
* It deploys built plugins into the Asset directory. Note that only plugins built for the current platform will be deployed (there is no cross-compilation).
2825
* It prepares Unity Asset that is ready to import into your Unity project.
29-
* By default, build process generates standalone libraries (on Windows only).
26+
* By default, build process generates standalone libraries on Windows.
3027
You can disable this feature by setting CMake option `STANDALONE_BUILD` to `OFF` (e.g. through editing `build.ps1`).
3128
* In order to generate `Ros2ForUnity.unitypackage` please run `create_unity_asset.ps1`. Please provide path to your Unity executable when prompted.
32-
* Asset can be found under `C:\dev\r2fu\install\unity_package` directory
29+
* Asset can be found in `install\unity_package` directory
3330
* In case your Unity license has expired, the `create_unity_asset.ps1` won't throw any errors but `Ros2ForUnity.unitypackage` won't be generated too.
3431
* At this moment you have two valid forms of the Asset.
35-
* One is available as `C:\dev\r2fu\src\Ros2ForUnity` folder.
36-
* Second one is `Ros2ForUnity.unitypackage`
32+
* One is available as `src\Ros2ForUnity` folder which you can simply copy to Unity3D `Assets` directory.
33+
* Second one is `Ros2ForUnity.unitypackage` which you can import in Unity3D.
3734

3835
## Build troubleshooting
3936

@@ -74,6 +71,6 @@ pip install numpy
7471
> If the Asset is built with `STANDALONE_BUILD` option set to `1` (the default), then nothing extra needs to be done.
7572
Otherwise, you have to source your ros distribution before launching either Unity3D Editor or Application.
7673

77-
> Note that after you build the Asset, you can use it on a machine that has no ros2 installation.
74+
> Note that after you build the Asset, you can use it on a machine that has no ros2 installation (if built with `STANDALONE_BUILD`).
7875
7976
> You can simply copy over the `Ros2ForUnity` subdirectory to update your Asset.

0 commit comments

Comments
 (0)