Skip to content

Commit 3a7b171

Browse files
committed
Update README
1 parent 69a864f commit 3a7b171

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,30 @@
1-
# Magic Python [![Build Status](https://travis-ci.org/MagicStack/MagicPython.svg?branch=master)](https://travis-ci.org/MagicStack/MagicPython) [![apm](https://img.shields.io/apm/dm/magicpython.svg?label=Atom)](https://atom.io/packages/magicpython) [![Package Control](https://img.shields.io/packagecontrol/dt/MagicPython.svg?label=Sublime%20Text)](https://packagecontrol.io/packages/MagicPython) [![VSM](https://vsmarketplacebadge.apphb.com/installs-short/magicstack.MagicPython.svg?subject=Visual%20Studio%20Code)](https://marketplace.visualstudio.com/items?itemName=magicstack.MagicPython)
1+
# Magic Python 3.10
22

3-
This is a package with preferences and syntax highlighter for cutting edge
4-
Python 3, although Python 2 is well supported, too. The syntax is compatible
5-
with [Sublime Text](http://www.sublimetext.com), [Atom](http://atom.io) and
6-
[Visual Studio Code](http://code.visualstudio.com). It is meant to be a drop-in
7-
replacement for the default Python package.
3+
<p align="center">
4+
<a href="https://github.com/TheJoeSmo/MagicPython/actions"><img alt="Actions Status" src="https://github.com/TheJoeSmo/MagicPython/actions/workflows/tests.yml/badge.svg"></a>
5+
<a href="https://github.com/TheJoeSmo/MagicPython/block/main/LICENSE.md"><img alt="License GPL3" src="https://img.shields.io/github/license/TheJoeSmo/MagicPython"></a>
6+
<a href="https://vsmarketplacebadge.apphb.com/installs-short/joesmo12.MagicPython310.svg"><img alt="Installs" src="https://vsmarketplacebadge.apphb.com/installs-short/joesmo12.MagicPython310.svg"></a>
7+
<a href="https://vsmarketplacebadge.apphb.com/version/joesmo12.MagicPython310.svg"><img alt="Visual Studio Code" src="https://vsmarketplacebadge.apphb.com/version/joesmo12.MagicPython310.svg"></a>
8+
</p>
89

9-
**Attention VSCode users**: MagicPython is used as the _default_
10-
Python highlighter in Visual Studio Code. Don't install it unless you
11-
want or need the cutting edge version of it. You will likely see no
12-
difference because you're already using MagicPython.
10+
A syntax highlighter for Python 3.10 and beyond Compatible with [Sublime Text](http://www.sublimetext.com) and [Visual Studio Code](http://code.visualstudio.com). Unlike other plugins, this plugin is designed simple. You download, install, and program. No twists, turns, or roundabouts.
1311

14-
MagicPython correctly highlights all Python 3 syntax features,
15-
including type annotations, f-strings and regular expressions. It is
16-
built from scratch for robustness with an extensive test suite.
12+
For VSC, MagicPython310 should be used as the default highlighter. It ensures that Python 3.10 and beyond will be properly highlighted. Versions prior to 3.10 will likely appear properly, but this feature is not guaranteed.
13+
14+
Our goal is to make match-case statements, type annotations, f-strings and regular expressions get the syntax highlighting they deserve. It is built from scratch for robustness with an extensive test suite.
1715

1816
Type hints in comments require support by the color scheme. The one
1917
used in the screenshot is
20-
[Chromodynamics](https://github.com/TheJoeSmo/Chromodynamics).
18+
[Chromodynamics](https://github.com/MagicPython/Chromodynamics).
2119

2220
![](https://magicstack.github.io/MagicPython/example.png)
2321

2422

25-
## Installation Instructions
23+
Installation Instructions
24+
-------------------------
2625

2726
This is meant to be a drop-in replacement for the default Python package.
2827

29-
In **Atom**, install the `MagicPython` package and disable the built-in
30-
`language-python` package.
31-
3228
In **Sublime Text**, install `MagicPython` package via "Package Control" and
3329
disable the built-in `Python` package (using
3430
`Package Control -> Disable Package`, or directly by adding `"Python"` to
@@ -198,7 +194,8 @@ all other keywords. Although the Python interpreter will produce an appropriate
198194
error message when reserved keywords are used as identifier names, it's still
199195
worth showing them early, to spare even this small debugging effort.
200196

201-
## Development
197+
Development
198+
-----------
202199

203200
You need `npm` and `node.js` to work on MagicPython.
204201

@@ -229,7 +226,8 @@ If you intend to submit a pull request, please follow the following guidelines:
229226
- update unit tests and add new ones if needed, keeping the test cases short
230227
whenever possible
231228

232-
### Multiple scopes
229+
Multiple scopes
230+
---------------
233231

234232
It is sometimes necessary to assign multiple scopes to the same
235233
matched group. It is *very important* to keep in mind that the order
@@ -242,7 +240,8 @@ chose one convention and then translate it when necessary during
242240
compilation step. Our convention is therefore that *most important
243241
scope goes first*.
244242

245-
## Color Scheme
243+
Color Scheme
244+
------------
246245

247246
If you want to write your own color scheme for MagicPython you can
248247
find a list of all the scopes that we use in

0 commit comments

Comments
 (0)