Telemetry

README.md

@@ -1,5 +1,4 @@
 # code-server
-
 [!["Open Issues"](https://img.shields.io/github/issues-raw/cdr/code-server.svg)](https://github.com/cdr/code-server/issues)
 [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest)
 [![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cdr/code-server/blob/master/LICENSE)
@@ -23,18 +22,14 @@ docker run -it -p 127.0.0.1:8443:8443 -p 127.0.0.1:8444:8444 -v "$PWD:/home/code
 ![Screenshot](/doc/assets/ide.png)
 
 ## Getting Started
-
 ### Run over SSH
-
 Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
 
 ### Docker
-
 See docker oneliner mentioned above. Dockerfile is at
 [/Dockerfile](/Dockerfile).
 
 ### Binaries
-
 1.  [Download a binary](https://github.com/cdr/code-server/releases) (Linux and
     OS X supported. Windows coming soon)
 2.  Start the binary with the project directory as the first argument
@@ -65,28 +60,15 @@ How to [secure your setup](/doc/security/ssl.md).
   compile the build directory as well.
 - For now `@coder/nbin` is a global dependency.
 - Run `yarn build ${codeServerVersion} ${vscodeVersion} ${target} ${arch}` in
-  this directory (for example: `yarn build development 1.35.0 linux x64`).
+  this directory (for example: `yarn build development 1.36.0 linux x64`).
+- If you target the same VS Code version our Travis builds do everything will
+  work but if you target some other version it might not (we have to do some
+  patching to VS Code so different versions aren't always compatible).
 - You can run the built code with `node path/to/build/out/vs/server/main.js` or run
   `yarn binary` with the same arguments in the previous step to package the
   code into a single binary.
 
-### Development
-
-```fish
-git clone https://github.com/microsoft/vscode
-cd vscode
-git clone https://github.com/cdr/code-server src/vs/server
-cd src/vs/server
-yarn patch:apply
-yarn
-yarn watch
-# Wait for the initial compilation to complete (it will say "Finished compilation").
-yarn start --allow-http --no-auth
-# Visit http://localhost:8443
-```
-
 ## Known Issues
-
 - Creating custom VS Code extensions and debugging them doesn't work.
 - To debug Golang using
   [ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go),
@@ -102,31 +84,48 @@ yarn start --allow-http --no-auth
 - Run VS Code unit tests against our builds to ensure features work as expected.
 
 ## Extensions
-
 At the moment we can't use the official VSCode Marketplace. We've created a
 custom extension marketplace focused around open-sourced extensions. However,
 if you have access to the `.vsix` file, you can manually install the extension.
 
 ## Telemetry
+Use the `--disable-telemetry` flag to completely disable telemetry.
 
-Set the `telemetry.enableTelemetry` user setting to false to disable telemetry.
-
-We use data collected to improve code-server.
+We use the data collected to improve code-server.
 
 ## Contributing
 
-Development guides are coming soon.
+### Development
+```fish
+git clone https://github.com/microsoft/vscode
+cd vscode
+git clone https://github.com/cdr/code-server src/vs/server
+cd src/vs/server
+yarn patch:apply
+yarn
+yarn watch
+# Wait for the initial compilation to complete (it will say "Finished compilation").
+yarn start --allow-http --no-auth
+# Visit http://localhost:8443
+```
+
+### Upgrading VS Code
+We have to patch VS Code to provide and fix some functionality. As the web
+portion of VS Code matures, we'll be able to shrink and maybe even entirely
+eliminate our patch. In the meantime, however, upgrading the VS Code version
+requires ensuring that the patch still applies and has the intended effects.
+
+To generate a new patch, **stage all the changes** you want to be included in
+the patch in the VS Code source, then run `yarn patch:generate` in this
+directory.
 
 ## License
-
 [MIT](LICENSE)
 
 ## Enterprise
-
 Visit [our enterprise page](https://coder.com/enterprise) for more information
 about our enterprise offering.
 
 ## Commercialization
-
 If you would like to commercialize code-server, please contact
 contact@coder.com.