forked from georgeduckett/TeamCoding
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Readme.tt
35 lines (24 loc) · 3.15 KB
/
Readme.tt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<#@ template language="C#" debug="false" hostspecific="true" #>
<#@ output extension=".md" #>
<#@ assembly name="$(SolutionDir)\TeamCoding\bin\Debug\TeamCoding.dll" #>
<#@ assembly name="$(SolutionDir)\TeamCoding\bin\Debug\TeamCoding.v14.dll" #>
Team Coding
--
**About:** <#= typeof(TeamCoding.TeamCodingPackage).Assembly.GetType("TeamCoding.Vsix").GetField("Description").GetRawConstantValue() #>
**Quickstart:** <#=System.IO.File.ReadAllText(Host.ResolveAssemblyReference("$(ProjectDir)") + "\\Resources\\GettingStarted.txt") #>
**Settings:** The settings are located at Tools->Options-><#= TeamCoding.Options.OptionPageGrid.OptionsName #>.
There are configuration options for your user identity (how you appear to others) and how others appear to you, as well as configuration options for how to share open document information with others.
Multiple methods can be used at once, you can also add a `<#= TeamCoding.Options.Settings.TeamCodingConfigFileName #>` file anywhere within the solution folder for it to override those settings.
If this file is in place then for that solution settings don't need to be set in each developer's IDE.
You can enable/disable the CodeLens addon in Tools->Options->Text Editor->All Language->Code Lens-><#= TeamCoding.VisualStudio.CodeLens.CurrentUsersDataPointProvider.CodeLensName #>.
For more details regarding the different user and shared options, see [Settings.md](https://github.com/georgeduckett/TeamCoding/blob/master/Settings.md)
**User Identity:** It tries to get your email address as a user identity from various sources (saved Windows Credentials for GitHub, your logged in identity from Visual Studio, your machine name).
This will be made public to your team. It uses Gravatar to get a user image from the email address.
**Overview window** There is a tool window that allows you to see every user and what documents they've got open in a treeview. To access it use the View->Other Windows->TeamCoding Overview command.
**Roadmap:** Still very much alpha, please report bugs as [GitHub issues](https://github.com/georgeduckett/TeamCoding/issues).
Currently sharing options are a shared folder, Redis, Slack, an SQL Server table or via a server application as a windows service or console application. If you want others (along with any other feature requests) please raise them as issues. Supports Git repos and Team Foundation Services / Visual Studio Online for determining what to share as well as a fall-back to sharing purely based on matching solution filenames. In the pipeline a shared-coding experience (multiple users editing the same document(s)).
**Reporting Bugs**: When reporting bugs ([here](https://github.com/georgeduckett/TeamCoding/issues)) please include information from the `<#= TeamCoding.Logging.Logger.OutputWindowCategory #>` tab in the output window (if relevent). If there were any exceptions they should be visible there, which can help track down the cause.
**Links:** [GitHub Repo](https://github.com/georgeduckett/TeamCoding/)
[](https://ci.appveyor.com/project/georgeduckett/teamcoding)
---
