Skip to content

Commit 7f85d7f

Browse files
committed
Update README.md
1 parent c6183e3 commit 7f85d7f

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,21 @@ You are recommended to use our GUI program to manipulate the project file.
3636
It allows you to initialize the project with ProtoBuf MSBuild targets and properties.
3737
It automatically selects the required build action when adding new `.proto` files.
3838

39-
1. Copy `ProtoBuf.MSBuildTask.dll` and `ProtoBuf.MSBuildTask.targets` to the directory of ProtoGen binaries.
40-
Currently, we require the `ProtoBuf.MSBuildTask` files to be in the directory of ProtoGen binaries.
39+
1. Copy `ProtoBuf.MSBuildTask.dll` and `ProtoBuf.MSBuildTask.targets` to your project in a separate directory.
4140
2. Launch `ProtoBuf.ProjectInserter.WinForms` program.
4241
3. Open project, pick the C# project you wish to enable `ProtoBuf.MSBuildTask`.
43-
4. Initialize project, pick the directory to ProtoGen binaries.
44-
Please put ProtoGen binaries in a location that is reachable from your repository.
45-
**Relative path** of the directory to ProtoGen binaries is saved to the project file.
46-
If ProtoGen binaries are located in another drive, **Absolute** path is saved.
47-
5. Add files, pick one or more files to add.
42+
4. Initialize project, pick the directories to `ProtoBuf.MSBuildTask` and `ProtoGen` binaries respectively.
43+
Please put `ProtoBuf.MSBuildTask` files and `ProtoGen` binaries in locations that are reachable from your repository.
44+
**Relative path** of the directories to these files are saved to the project file.
45+
If these files are located in another drive, **Absolute** path will be saved.
46+
5. Add ProtoBuf files, pick one or more files to add.
4847
6. Save project.
4948

5049
If you wish to manually add new `.proto` files to the project in Visual Studio or SharpDevelop,
5150
remember to select `Build Action`: `ProtoBuf` and enter `Custom Tool`: `MSBuild:Compile`.
5251

52+
Note: Protocol files must reside in project directory or its subdirectories. `ProtoGen` does not support upper level such as `..\x.proto`.
53+
5354
How to Contribute?
5455
--------------------
5556
Development happens on github. You are welcome to open pull requests or file issues.

0 commit comments

Comments
 (0)