From bfcfedb1e8580a2df57f5921250f92ed42a49eb6 Mon Sep 17 00:00:00 2001 From: Peter Squicciarini Date: Wed, 24 Oct 2018 10:34:20 -0400 Subject: [PATCH] Separate out more technical docs into DOCS.md --- DOCS.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 44 +++----------------------------------------- 2 files changed, 56 insertions(+), 41 deletions(-) create mode 100644 DOCS.md diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..1d91e9b --- /dev/null +++ b/DOCS.md @@ -0,0 +1,53 @@ +# More Info + +## Table of Contents +- [Getting all the Telemetry Out](#disable-telemetry) +- [Extensions + Marketplace](#extensions-marketplace) +- [Migrating from Visual Studio Code to VSCodium](#migrating) +- [How do I press and hold a key and have it repeat in VSCodium?](#press-and-hold) + +## Getting all the Telemetry Out +Even though we do not pass the telemetry build flags (and go out of our way to cripple the baked-in telemetry), Microsoft will still track usage by default. + +We do however set the default `telemetry.enableCrashReporter` and `telemetry.enableTelemetry` values to false. You can see those by viewing your VSCodium settings.json and searching for `telemetry`. + +The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with explaining and toggling telemetry. + +It is also highly recommended that you review all the settings that "use online services" by following [these instructions](https://code.visualstudio.com/docs/supporting/faq#_managing-online-services). The `@tag:usesOnlineServices` filter on the settings page will show that by default: +- Extensions auto check for updates and auto install updates +- Searches within the app are sent to an online service for "natural language processing" +- Updates to the app are fetched in the background + +These can all be disabled. + +__Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ + +_(For example the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_ + +## Extensions + Marketplace +Until something more open comes around, we use the Microsoft Marketplace/Extensions in the `product.json` file. Those links are licensed under MIT as per [the comments on this issue.](https://github.com/Microsoft/vscode/issues/31168#issuecomment-317319063) + +## Migrating from Visual Studio Code to VSCodium +VSCodium (and a freshly cloned copy of vscode built from source) stores its extension files in `~/.vscode-oss`. So if you currently have Visual Studio Code installed, your extensions won't automatically populate. You can reinstall your extensions from the Marketplace in VSCodium, or copy the `extensions` from `~/.vscode/extensions` to `~/.vscode-oss/extensions`. + +Visual Studio Code stores its `keybindings.json` and `settings.json` file in the these locations: +- __Windows__: `%APPDATA%\Code\User` +- __macOS__: `$HOME/Library/Application Support/Code/User` +- __Linux__: `$HOME/.config/Code/User` + +You can copy these files to the VSCodium user settings folder: +- __Windows__: `%APPDATA%\VSCodium\User` +- __macOS__: `$HOME/Library/Application Support/VSCodium/User` +- __Linux__: `$HOME/.config/VSCodium/User` + +To copy your settings manually: +- In Visual Studio Code, go to Settings (Command+, if on a Mac) +- Click the three dots `...` and choose 'Open settings.json' +- Copy the contents of settings.json into the same place in VSCodium + +## How do I press and hold a key and have it repeat in VSCodium (Mac)? +This is a common question for Visual Studio Code and the procedure is slightly different in VSCodium because the `defaults` path is different. + +```bash +$ defaults write com.visualstudio.code.oss ApplePressAndHoldEnabled -bool false +``` diff --git a/README.md b/README.md index cca49e1..bff0ac8 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,8 @@ - [Install with Brew](#install-with-brew) - [Install with Package Manager](#install-with-package-manager) - [Why Does This Exist](#why) -- [Getting all the Telemetry Out](#disable-telemetry) +- [More Info](#more-info) - [Supported OS](#supported-os) -- [Extensions + Marketplace](#extensions-marketplace) -- [Migrating from Visual Studio Code to VSCodium](#migrating) ## Download/Install :tada: :tada: [Download latest release here](https://github.com/VSCodium/vscodium/releases) :tada: :tada: @@ -51,23 +49,8 @@ Microsoft's build process does download additional files. This was brought up in - electron - ffmpeg -## Getting all the Telemetry Out -Even though we do not pass the telemetry build flags (and go out of our way to cripple the baked-in telemetry), Microsoft will still track usage by default. - -We do however set the default `telemetry.enableCrashReporter` and `telemetry.enableTelemetry` values to false. You can see those by viewing your VSCodium settings.json and searching for `telemetry`. - -The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with explaining and toggling telemetry. - -It is also highly recommended that you review all the settings that "use online services" by following [these instructions](https://code.visualstudio.com/docs/supporting/faq#_managing-online-services). The `@tag:usesOnlineServices` filter on the settings page will show that by default: -- Extensions auto check for updates and auto install updates -- Searches within the app are sent to an online service for "natural language processing" -- Updates to the app are fetched in the background - -These can all be disabled. - -__Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ - -_(For example the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_ +## More Info +For more information on getting all the telemetry disabled and tips for migrating from Visual Studio Code to VSCodium, have a look at this [Docs](https://github.com/VSCodium/vscodium/blob/master/DOCS.md) page. ## Supported OS - [x] OSX x64 (zipped app file) @@ -78,26 +61,5 @@ _(For example the C# extension `ms-vscode.csharp` sends tracking data to Microso The ARM architecture is not currently supported but is actively being worked on. -## Extensions + Marketplace -Until something more open comes around, we use the Microsoft Marketplace/Extensions in the `product.json` file. Those links are licensed under MIT as per [the comments on this issue.](https://github.com/Microsoft/vscode/issues/31168#issuecomment-317319063) - -## Migrating from Visual Studio Code to VSCodium -VSCodium (and a freshly cloned copy of vscode built from source) stores its extension files in `~/.vscode-oss`. So if you currently have Visual Studio Code installed, your extensions won't automatically populate. You can reinstall your extensions from the Marketplace in VSCodium, or copy the `extensions` from `~/.vscode/extensions` to `~/.vscode-oss/extensions`. - -Visual Studio Code stores its `keybindings.json` and `settings.json` file in the these locations: -- __Windows__: `%APPDATA%\Code\User` -- __macOS__: `$HOME/Library/Application Support/Code/User` -- __Linux__: `$HOME/.config/Code/User` - -You can copy these files to the VSCodium user settings folder: -- __Windows__: `%APPDATA%\VSCodium\User` -- __macOS__: `$HOME/Library/Application Support/VSCodium/User` -- __Linux__: `$HOME/.config/VSCodium/User` - -To copy your settings manually: -- In Visual Studio Code, go to Settings (Command+, if on a Mac) -- Click the three dots `...` and choose 'Open settings.json' -- Copy the contents of settings.json into the same place in VSCodium - ## License MIT