]> git.madduck.net Git - etc/vim.git/blob - docs/getting_started.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Fix grammar for type alias support (#3949)
[etc/vim.git] / docs / getting_started.md
1 # Getting Started
2
3 New to _Black_? Don't worry, you've found the perfect place to get started!
4
5 ## Do you like the _Black_ code style?
6
7 Before using _Black_ on some of your code, it might be a good idea to first understand
8 how _Black_ will format your code. _Black_ isn't for everyone and you may find something
9 that is a dealbreaker for you personally, which is okay! The current _Black_ code style
10 [is described here](./the_black_code_style/current_style.md).
11
12 ## Try it out online
13
14 Also, you can try out _Black_ online for minimal fuss on the
15 [Black Playground](https://black.vercel.app) generously created by José Padilla.
16
17 ## Installation
18
19 _Black_ can be installed by running `pip install black`. It requires Python 3.8+ to run.
20 If you want to format Jupyter Notebooks, install with `pip install "black[jupyter]"`.
21
22 If you can't wait for the latest _hotness_ and want to install from GitHub, use:
23
24 `pip install git+https://github.com/psf/black`
25
26 ## Basic usage
27
28 To get started right away with sensible defaults:
29
30 ```sh
31 black {source_file_or_directory}...
32 ```
33
34 You can run _Black_ as a package if running it as a script doesn't work:
35
36 ```sh
37 python -m black {source_file_or_directory}...
38 ```
39
40 ## Next steps
41
42 Took a look at [the _Black_ code style](./the_black_code_style/current_style.md) and
43 tried out _Black_? Fantastic, you're ready for more. Why not explore some more on using
44 _Black_ by reading
45 [Usage and Configuration: The basics](./usage_and_configuration/the_basics.md).
46 Alternatively, you can check out the
47 [Introducing _Black_ to your project](./guides/introducing_black_to_your_project.md)
48 guide.