Skip to content

Commit

Permalink
Merge branch 'master' of github.com:shantanu3637/CollaBroText
Browse files Browse the repository at this point in the history
  • Loading branch information
SSKUltra committed Aug 20, 2017
2 parents c35796d + fd6114c commit 87d51a9
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This plugin is used to enhance collaboration between software developers working
Main functionality is commenting on a file in a similar way to how Google Docs does it.
We are using git to keep the comments synced via Github or any other site you may wish to use for your project.


## Installation instructions
1) Clone source code to Sublime Text packages folder.

Expand All @@ -22,6 +23,12 @@ We are using git to keep the comments synced via Github or any other site you ma
☐ To sync your comments (background Git pull & push) press <kbd> Ctrl + s</kbd> (Normal save via keyboard)


## Important
1) Plugin only works if file present in ssh enabled git-versioned folder.
2) Make sure that <kbd>Alt + x</kbd>: Close comment tab is used to close the comments tab.
DO NOT CLOSE COMMENTS TAB MANUALLY by clicking on close button


## Themes
There is an option to change the theme of the comments tab
The default theme is notebook
Expand All @@ -37,14 +44,14 @@ We have three other options in themes
To change theme

☐ Go to Preferences menu in Sublime Text

☐ Go to Package Settings -> CollaBroText -> Settings-Default

☐ Copy contents of this file into Preferences -> Package Settings -> CollaBroText -> Settings-User

☐ Replace "notebook" to name of the theme you want and save. The theme of the comments tab will change.


☐ Replace "notebook" to name of the theme you want and save. The theme of the comments tab will change.


These are the screen shots of the working plugin


Expand Down

0 comments on commit 87d51a9

Please sign in to comment.