Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inline code #35

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
#Rebracer
# Rebracer

Rebracer solves an age-old problem with working on C# projects from a variety of source: source formatting settings.
If you work on different open source projects, or on projects for different companies, each one is likely to have a different One True Brace Style, forcing you to change your Visual Studio settings every time you switch projects.

Rebracer solves this by storing these settings alongside each solution. When you open a solution, Rebracer will automatically apply that solution's settings, leaving you free to write code as usual.

##How it works
## How it works
Whenever you open a solution, Rebracer will check for a `Rebracer.xml` file in the solution directory. If it finds one, it will load all settings from that file so that the solution will use its specified settings. When you change settings in Visual Studio's regular Options dialog, Rebracer will update the XML file with the changed settings.

To use Rebracer for a new solution, right-click the solution, click Add, New Rebracer Settings File. This will create a Rebracer.xml for the solution, seeded with your current VS settings. You can then open the Options dialog to choose settings specific to that solution. From then on, anyone who opens that solution with Rebracer installed will get those settings. You can also copy an existing Rebracer.xml file from a different solution to start with its settings. If so, you must close and re-open the solution to pick up the new file.

##FAQ
## FAQ
- Q: I want to contribute to a project that uses Rebracer. What do I need to do?
A: Just install Rebracer from the Visual Studio Extension Gallery. That's it – you don't need to do anything else.

Expand All @@ -22,12 +22,12 @@ To use Rebracer for a new solution, right-click the solution, click Add, New Reb

- Q: What about tabs vs. spaces?
A: Use the existing [EditorConfig extension](http://visualstudiogallery.msdn.microsoft.com/c8bccfe2-650c-4b42-bc5c-845e21f96328), which allows you to specify newline and whitespace settings for individual files or patterns, and works with most editors.
If you want to maintain a single settings file, you can manually add `<ToolsOptionsSubCategory name="CSharp">` under `<ToolsOptionsCategory name="TextEditor">` in Rebracer.xml:
```
<ToolsOptionsSubCategory name="CSharp">
<PropertyValue name="InsertTabs">true</PropertyValue>
</ToolsOptionsSubCategory>
```
If you want to maintain a single settings file, you can manually add `<ToolsOptionsSubCategory name="CSharp">` under `<ToolsOptionsCategory name="TextEditor">` in Rebracer.xml:
```
<ToolsOptionsSubCategory name="CSharp">
<PropertyValue name="InsertTabs">true</PropertyValue>
</ToolsOptionsSubCategory>
```

- Q: Will this mess up my global settings for projects that don't use Rebracer?
A: Nope! Rebracer maintains a separate XML file in your Visual Studio profile containing your original global settings. If you open or create a solution that doesn't have a Rebracer settings file, it will revert to your existing global settings.
Expand All @@ -49,5 +49,5 @@ To use Rebracer for a new solution, right-click the solution, click Add, New Reb
A: Great question! I have no idea.
Adding such compatibility would require a separate version of this extension for MonoDevelop, which would need to map property names from Visual Studio.

#License
# License
[MIT](http://opensource.org/licenses/MIT)