Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 6.38 KB

README.md

File metadata and controls

98 lines (63 loc) · 6.38 KB

current release license

This is a fork of VSCodium with compiler optimizations, rebranding as "Codium", restoration of the upstream icon, and RESTORED WINDOWS 7/8/8.1 Support!. It also supports Ubuntu 18.04/Debian 9.

Table of Contents

Download/Install

🎉 🎉 Download latest release in the releases section > https://github.com/Alex313031/codium/releases 🎉 🎉

More info / helpful tips are here.

Any issues installing Codium using your package manager should be directed to that repository's issue tracker.

Building

Build instructions can be found here

Why Does This Exist

This repository contains build files to generate free release binaries of Microsoft's VS Code. When we speak of "free software", we're talking about freedom, not price.

Microsoft's releases of Visual Studio Code are licensed under this not-FLOSS license and contain telemetry/tracking. According to this comment from a Visual Studio Code maintainer:

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

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. These binaries are licensed under the MIT license. Telemetry is disabled.

If you want to build from source yourself, head over to Microsoft's vscode repo and follow their instructions. This repo exists to make it easier to get the latest version of MIT-licensed VS Code.

Microsoft's build process (which we are running to build the binaries) does download additional files. Those packages downloaded during build are:

More Info

Documentation

For more information on getting all the telemetry disabled, tips for migrating from Visual Studio Code to Codium and more, have a look at the Docs page page.

Troubleshooting

If you have any issue, please check the Troubleshooting page or the existing issues.

Extensions and the Marketplace

According to the VS Code Marketplace Terms of Use, you may only install and use Marketplace Offerings with Visual Studio Products and Services. For this reason, Codium uses open-vsx.org, an open source registry for VS Code extensions. See the Extensions + Marketplace section on the Docs page for more details.

Please note that some Visual Studio Code extensions have licenses that restrict their use to the official Visual Studio Code builds and therefore do not work with Codium. See this note on the Docs page for what's been found so far and possible workarounds.

How are the Codium binaries built?

If you would like to see the commands we run to build vscode into Codium binaries, have a look at the workflow files in .github/workflows for Windows, GNU/Linux and macOS. These build files call all the other scripts in the repo. If you find something that doesn't make sense, feel free to ask about it in an issue or in the discussions.

The builds are run every day, but exit early if there isn't a new release from Microsoft.

Supported Platforms

The minimal version is limited by the core component Electron, you may want to check its platform prerequisites.

  • macOS (zip, dmg) OS X 10.13 or newer x64
  • macOS (zip, dmg) macOS 11.0 or newer arm64
  • GNU/Linux x64 (deb, rpm, AppImage, tar.gz)
  • GNU/Linux arm64 (deb, rpm, tar.gz)
  • Windows 7 or newer x64
  • Windows 7 or newer x86
  • Windows Server 2012 R2 or newer arm64

License

MIT