Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
DirkBrand committed Jan 31, 2014
2 parents 68d974f + 11f1ccd commit 2bb07df
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,6 @@ ProtoBufCodeFormatter_Sublime

Sublime-Text-2 plugin that allows auto-formatting of Protocol Buffer Code on save.

Limitations
===========
1. Formatter cannot preserve order of structures. The order is pre-determined.

2. For comments, outer `extend' groups are logically grouped together, so inner comments are lost.

3. Style of comments are not preserved (/* */ vs. //), so both single-line and multi-line comments are shown with `//`.



Installation
============
`ProtoBufCodeFormatter` is available via [Package Control][pkg-ctrl] and can be found as `ProtoBufCodeFormatter`.
Expand All @@ -26,10 +16,18 @@ Requirements
============

- [Golang][go] v1.0 or higher
- Correctly set `PROTOPATH` and `GOBIN` in the `.sublime-settings file`.
- Correctly set `PROTOPATH`, `GOROOT` and `GOBIN` in the `Settings - User`.


In the package folder, edit the `CodeFormatter.sublime-settings` to contain the correct path information. Under `GOBIN`, enter the location of your Go Binary. Under `PROTOPATH`, enter any locations of Protocol Buffers that are imported by your protocol buffers.
Open `Settings - User` under `Preferences/Package Settings` and edit to contain the correct path information. Add variable `GOBIN` and enter the location of your Go Binary. Add variable `PROTOPATH` and enter any locations of Protocol Buffers that are imported by your protocol buffers. Optionally add a `GOROOT` variable to show the location of your Go workspace. Look at `Settings - Default` as an example.


[go]: http://golang.org/


Limitations
===========
1. Formatter cannot preserve order of structures. The order is pre-determined.

2. For comments, outer `extend' groups are logically grouped together, so inner comments are lost.

3. Style of comments are not preserved (/* */ vs. //), so both single-line and multi-line comments are shown with `//`.

0 comments on commit 2bb07df

Please sign in to comment.