Skip to content

Commit f386843

Browse files
committed
Add README.markdown
1 parent c3dcfea commit f386843

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
ProtoBuf.MSBuildTask
2+
====================
3+
4+
MSBuild Task for [protobuf-net](https://code.google.com/p/protobuf-net/).
5+
6+
The Modules
7+
--------------------
8+
### ProtoBuf.MSBuildTask
9+
This contains the build task DLL and targets file.
10+
11+
### ProtoBuf.Project
12+
This is a library for manipulating Visual Studio project file with necessary stuff for using `ProtoBuf.MSBuildTask`.
13+
14+
### ProtoBuf.ProjectInserter.WinForms
15+
This is a GUI program that calls the library `ProtoBuf.Project` to manipulate Visual Studio project file.
16+
17+
System Requirement
18+
--------------------
19+
- Visual Studio 2010, 2012 or 2013, Professional or Express.
20+
- .NET 4 Full
21+
- ProtoGen binaries from [protobuf-net](https://code.google.com/p/protobuf-net/), 1.0.0.280
22+
23+
What it Does?
24+
--------------------
25+
### Convert protocol buffer files into code
26+
- Call ProtoGen binaries to convert `.proto` files into a `.cs`
27+
28+
### Build a `ProtoBuf.MSBuildTask` enabled project from
29+
- Visual Studio
30+
- MSBuild command line
31+
- SharpDevelop, however, without code completion function
32+
33+
How to Use?
34+
--------------------
35+
You are recommended to use our GUI program to manipulate the project file.
36+
It allows you to initialize the project with ProtoBuf MSBuild targets and properties.
37+
It automatically selects the required build action when adding new `.proto` files.
38+
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.
41+
2. Launch `ProtoBuf.ProjectInserter.WinForms` program.
42+
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.
48+
6. Save project.
49+
50+
If you wish to manually add new `.proto` files to the project in Visual Studio or SharpDevelop,
51+
remember to select `Build Action`: `ProtoBuf` and enter `Custom Tool`: `MSBuild:Compile`.
52+
53+
How to Contribute?
54+
--------------------
55+
Development happens on github. You are welcome to open pull requests or file issues.
56+
57+
License
58+
--------------------
59+
`ProtoBuf.MSBuildTask` is licensed under MIT License.
60+
This means you can use the library from any program, proprietary or open source.
61+
See `License.txt` file for the full license text.

0 commit comments

Comments
 (0)