-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move README.md to the top level (#3647)
Removes the stale README.md from Code OSS upstream. Add a TM trademark to the Positron title. Addresses #3646
- Loading branch information
1 parent
61512cc
commit e5232f8
Showing
2 changed files
with
20 additions
and
99 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,36 @@ | ||
| # Visual Studio Code - Open Source ("Code - OSS") | ||
| # Positron™ <a href="https://github.com/posit-dev/positron"><img src="positron-product-icons/positron.png" align="right" height="138" alt="Positron" /></a> | ||
|
|
||
| [](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) | ||
| [](https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug) | ||
| [](https://gitter.im/Microsoft/vscode) | ||
| What is Positron? | ||
|
|
||
| ## The Repository | ||
| - A next-generation data science IDE built by [Posit PBC](https://posit.co/) | ||
| - An extensible, polyglot tool for writing code and exploring data | ||
| - A familiar environment for reproducible authoring and publishing | ||
|
|
||
| This repository ("`Code - OSS`") is where we (Microsoft) develop the [Visual Studio Code](https://code.visualstudio.com) product together with the community. Not only do we work on code and issues here, we also publish our [roadmap](https://github.com/microsoft/vscode/wiki/Roadmap), [monthly iteration plans](https://github.com/microsoft/vscode/wiki/Iteration-Plans), and our [endgame plans](https://github.com/microsoft/vscode/wiki/Running-the-Endgame). This source code is available to everyone under the standard [MIT license](https://github.com/microsoft/vscode/blob/main/LICENSE.txt). | ||
| > [!IMPORTANT] | ||
| > Positron is an early stage project under active development and may [not yet be a good fit for you](https://github.com/posit-dev/positron/wiki#is-positron-for-me). If you are interested in experimenting with it, we welcome your feedback! | ||
| ## Visual Studio Code | ||
| ## Get started using Positron | ||
|
|
||
| <p align="center"> | ||
| <img alt="VS Code in action" src="https://user-images.githubusercontent.com/35271042/118224532-3842c400-b438-11eb-923d-a5f66fa6785a.png"> | ||
| </p> | ||
| Check out [our wiki](https://github.com/posit-dev/positron/wiki) for information on what you should do before installing Positron, troubleshooting Positron, and more. | ||
|
|
||
| [Visual Studio Code](https://code.visualstudio.com) is a distribution of the `Code - OSS` repository with Microsoft-specific customizations released under a traditional [Microsoft product license](https://code.visualstudio.com/License/). | ||
| Positron is built on [Code OSS](https://github.com/microsoft/vscode). To learn about basic features like commands, settings, using source control, and more, see the [VS Code documentation](https://code.visualstudio.com/docs). | ||
|
|
||
| [Visual Studio Code](https://code.visualstudio.com) combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle. It provides comprehensive code editing, navigation, and understanding support along with lightweight debugging, a rich extensibility model, and lightweight integration with existing tools. | ||
| ## Install Positron | ||
|
|
||
| Visual Studio Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on [Visual Studio Code's website](https://code.visualstudio.com/Download). To get the latest releases every day, install the [Insiders build](https://code.visualstudio.com/insiders). | ||
| Install Positron from our [Releases](https://github.com/posit-dev/positron/releases) page. | ||
|
|
||
| ## Contributing | ||
| Currently, Positron is producing pre-release builds from a continuous integration (CI) system for macOS, Windows, and Linux. These pre-release builds are tagged with a version number here on our Github repository. Select the build you want to download, then click on **Assets** and download the `.dmg` (for Mac), `.exe` (for Windows), or `.deb` (for Linux) file. | ||
|
|
||
| There are many ways in which you can participate in this project, for example: | ||
| ## Share your feedback about Positron | ||
|
|
||
| * [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues), and help us verify as they are checked in | ||
| * Review [source code changes](https://github.com/microsoft/vscode/pulls) | ||
| * Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to additional and new content | ||
| We invite you to join us on [GitHub Discussions](https://github.com/posit-dev/positron/discussions) to ask questions and share feedback. [Read more](https://github.com/posit-dev/positron/wiki/Feedback-and-Issues) about giving feedback and reporting bugs. | ||
|
|
||
| If you are interested in fixing issues and contributing directly to the code base, | ||
| please see the document [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute), which covers the following: | ||
| ## Code of conduct | ||
|
|
||
| * [How to build and run from source](https://github.com/microsoft/vscode/wiki/How-to-Contribute) | ||
| * [The development workflow, including debugging and running tests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#debugging) | ||
| * [Coding guidelines](https://github.com/microsoft/vscode/wiki/Coding-Guidelines) | ||
| * [Submitting pull requests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#pull-requests) | ||
| * [Finding an issue to work on](https://github.com/microsoft/vscode/wiki/How-to-Contribute#where-to-contribute) | ||
| * [Contributing to translations](https://aka.ms/vscodeloc) | ||
|
|
||
| ## Feedback | ||
|
|
||
| * Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) | ||
| * [Request a new feature](CONTRIBUTING.md) | ||
| * Upvote [popular feature requests](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) | ||
| * [File an issue](https://github.com/microsoft/vscode/issues) | ||
| * Connect with the extension author community on [GitHub Discussions](https://github.com/microsoft/vscode-discussions/discussions) or [Slack](https://aka.ms/vscode-dev-community) | ||
| * Follow [@code](https://twitter.com/code) and let us know what you think! | ||
|
|
||
| See our [wiki](https://github.com/microsoft/vscode/wiki/Feedback-Channels) for a description of each of these channels and information on some other available community-driven channels. | ||
|
|
||
| ## Related Projects | ||
|
|
||
| Many of the core components and extensions to VS Code live in their own repositories on GitHub. For example, the [node debug adapter](https://github.com/microsoft/vscode-node-debug) and the [mono debug adapter](https://github.com/microsoft/vscode-mono-debug) repositories are separate from each other. For a complete list, please visit the [Related Projects](https://github.com/microsoft/vscode/wiki/Related-Projects) page on our [wiki](https://github.com/microsoft/vscode/wiki). | ||
|
|
||
| ## Bundled Extensions | ||
|
|
||
| VS Code includes a set of built-in extensions located in the [extensions](extensions) folder, including grammars and snippets for many languages. Extensions that provide rich language support (code completion, Go to Definition) for a language have the suffix `language-features`. For example, the `json` extension provides coloring for `JSON` and the `json-language-features` extension provides rich language support for `JSON`. | ||
|
|
||
| ## Development Container | ||
|
|
||
| This repository includes a Visual Studio Code Dev Containers / GitHub Codespaces development container. | ||
|
|
||
| * For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows. | ||
| * If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. | ||
|
|
||
| * For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command. | ||
|
|
||
| Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
| Please note that this project is released with a [Contributor Code of | ||
| Conduct](https://github.com/posit-dev/positron/?tab=coc-ov-file#readme). By participating | ||
| in this project you agree to abide by its terms. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Licensed under the [MIT](LICENSE.txt) license. | ||
| Positron is licensed under the [Elastic License 2.0](https://github.com/posit-dev/positron?tab=License-1-ov-file#readme), a source-available license. [Read more](https://github.com/posit-dev/positron/wiki/Licensing) about what this license means and our decision to use it. |