Separate out more technical docs into DOCS.md
This commit is contained in:
Peter Squicciarini
parent
74d06bf01d
commit
bfcfedb1e8
2 changed files with 56 additions and 41 deletions
53
DOCS.md
Normal file
53
DOCS.md
Normal file
|
|
@ -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)
|
||||||
|
|
||||||
|
## <a id="disable-telemetry"></a>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.)_
|
||||||
|
|
||||||
|
## <a id="extensions-marketplace"></a>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)
|
||||||
|
|
||||||
|
## <a id="migrating"></a>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
|
||||||
|
|
||||||
|
## <a id="press-and-hold"></a>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
|
||||||
|
```
|
||||||
44
README.md
44
README.md
|
|
@ -10,10 +10,8 @@
|
||||||
- [Install with Brew](#install-with-brew)
|
- [Install with Brew](#install-with-brew)
|
||||||
- [Install with Package Manager](#install-with-package-manager)
|
- [Install with Package Manager](#install-with-package-manager)
|
||||||
- [Why Does This Exist](#why)
|
- [Why Does This Exist](#why)
|
||||||
- [Getting all the Telemetry Out](#disable-telemetry)
|
- [More Info](#more-info)
|
||||||
- [Supported OS](#supported-os)
|
- [Supported OS](#supported-os)
|
||||||
- [Extensions + Marketplace](#extensions-marketplace)
|
|
||||||
- [Migrating from Visual Studio Code to VSCodium](#migrating)
|
|
||||||
|
|
||||||
## <a id="download-install"></a>Download/Install
|
## <a id="download-install"></a>Download/Install
|
||||||
:tada: :tada: [Download latest release here](https://github.com/VSCodium/vscodium/releases) :tada: :tada:
|
: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
|
- electron
|
||||||
- ffmpeg
|
- ffmpeg
|
||||||
|
|
||||||
## <a id="disable-telemetry"></a>Getting all the Telemetry Out
|
## <a id="more-info"></a>More Info
|
||||||
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.
|
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.
|
||||||
|
|
||||||
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.)_
|
|
||||||
|
|
||||||
## <a id="supported-os"></a>Supported OS
|
## <a id="supported-os"></a>Supported OS
|
||||||
- [x] OSX x64 (zipped app file)
|
- [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.
|
The ARM architecture is not currently supported but is actively being worked on.
|
||||||
|
|
||||||
## <a id="extensions-marketplace"></a>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)
|
|
||||||
|
|
||||||
## <a id="migrating"></a>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
|
|
||||||
|
|
||||||
## <a id="license"></a>License
|
## <a id="license"></a>License
|
||||||
MIT
|
MIT
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue