microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-09-11 16:06:39 +03:00
Code Issues Projects Releases Wiki Activity

Moved installation section of README further up.

Browse Source
This commit is contained in:
Eric Traut 2019-04-19 10:04:57 -07:00
parent 7653cab0af
commit d9e47597ce
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -28,6 +28,23 @@ Pyright includes both a [command-line tool](/docs/command-line.md) and an [exten
For rich Python editing and debugging cabailities with Visual Studio Code, be sure to also install the official [Microsoft Python extension for Visual Studio Code](https://marketplace.visualstudio.com/itemdetails?itemName=ms-python.python) as Pyright only provides syntax and type checking.
## Installation
You can install the latest-published version of the Pyright VS Code extension directly from VS Code. Simply open the extensions panel and search for `pyright`.
The latest version of the command-line tool can be installed with npm. To install it globally:
`npm install -g pyright`
On MacOS or Linux, sudo is required to install globally:
`sudo npm install -g pyright`
Once installed, you can run the tool from the command line as follows:
`pyright <options>`
To update to the latest version:
`sudo npm update -g pyright`
## Documentation
* [Getting Started with Type Checking](/docs/getting-started.md)
* [Command-line Options](/docs/command-line.md)
@ -57,22 +74,6 @@ Pyright is a work in progress. Type-checking capabilities are not fully implemen
**A:** Pyright is a side project with no dedicated team. There is no guarantee of continued development on the project. If you find it useful, feel free to use it and contribute to the code base.
## Installation
You can install the latest-published version of the Pyright VS Code extension directly from VS Code. Simply open the extensions panel and search for `pyright`.
The latest version of the command-line tool can be installed with npm. To install it globally:
`npm install -g pyright`
On MacOS or Linux, sudo is required to install globally:
`sudo npm install -g pyright`
Once installed, you can run the tool from the command line as follows:
`pyright <options>`
To update to the latest version:
`sudo npm update -g pyright`
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.