diff --git a/README.md b/README.md index 5b8e46e..311b356 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,39 @@ # VSCodium ### Free/Libre Open Source Software Binaries of VSCode -## Download/Install +## Table of Contents +- [Download/Install](#download-install) + - [Install with Brew](#install-with-brew) +- [Why Does This Exist](#why) +- [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: -#### Install with Brew +#### Install with Brew If you are on a Mac and have [Homebrew](https://brew.sh/) installed: ```bash brew cask install vscodium ``` -__Note: if you see "App can’t be opened because it is from an unidentified developer" when opening VSCodium the first time, you can right-click the application and choose Open. This should only be required the first time opening on a Mac.__ +_Note: if you see "App can’t be opened because it is from an unidentified developer" when opening VSCodium the first time, you can right-click the application and choose Open. This should only be required the first time opening on a Mac._ -## Why +## Why Does This Exist This repository contains a build file to generate FLOSS release binaries of Microsoft's VSCode. -Microsoft's downloads of VSCode are licensed under [this not-FLOSS license](https://code.visualstudio.com/license). That's why this repo exists. So you don't have to download+build from source. If you want to build from source, definitely head over to https://github.com/Microsoft/vscode and follow the [instructions](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run). +Microsoft's downloads of Visual Studio Code are licensed under [this not-FLOSS license](https://code.visualstudio.com/license) and contain telemetry/tracking. According to [this comment](https://github.com/Microsoft/vscode/issues/60#issuecomment-161792005) from a Visual Studio Code maintainer: -## 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) +> When we [Microsoft] build Visual Studio Code, we do exactly this. We clone the vscode repository, we lay down a customized product.json that has Microsoft specific functionality (telemetry, gallery, logo, etc.), and then produce a build that we release under our license. +> +> When you clone and build from the vscode repo, none of these endpoints are configured in the default product.json. Therefore, you generate a "clean" build, without the Microsoft customizations, which is by default licensed under the MIT license -VSCodium (and a freshly cloned copy of vscode built from source) stores its config files in ~/.vscode-oss. So if you currently have Visual Studio Code installed, your extensions and settings won't automatically populate. You can reinstall extensions and copy settings over manually by following these steps: -- 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 +This repo exists so that you don't have to download+build from source. The build scripts in this repo clone Microsoft's vscode repo, run the build commands, and upload the resulting binaries to [GitHub releases](https://github.com/VSCodium/vscodium/releases). __These binaries don't have the telemetry/tracking, and are licensed under the MIT license. Telemetry is enabled by a build flag which we do not pass.__ -## Supported OS +If you want to build from source yourself, head over to https://github.com/Microsoft/vscode and follow their [instructions](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#build-and-run). This repo exists to make it easier to get the latest version of MIT-licensed VSCode. + +## Supported OS - [x] OSX x64 (zipped app file) - [x] Linux x64 (`.deb`, `.rpm`, and `.tar.gz` files) - [ ] Windows x64 @@ -33,5 +41,27 @@ VSCodium (and a freshly cloned copy of vscode built from source) stores its conf x32 and arm architectures are not currently supported. If you know of a way to do this with Travis or any other free CI/CD platform please put in an issue or a PR. -## License +## 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