Skip to content

Commit 511ec86

Browse files
committed
Add Installation section to README.md
1 parent f57d459 commit 511ec86

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,20 @@ website generation.
2121
it's simple to integrate tools like imagemagick, dart-sass, or less.js if you
2222
need them.
2323

24+
## Installation
25+
26+
Anchovy has no essential prerequisites and can be installed with
27+
`pip install anchovy` to get just the framework and a few built-in components,
28+
but for typical usage `pip install anchovy[base]` is recommended. This will
29+
pull in support for Jinja2 templating, markdown, and Anchovy's CSS preprocessor.
30+
A full list of available extras may be found in the
31+
[pyproject.toml](https://github.com/pydsigner/anchovy/blob/master/pyproject.toml)
32+
file.
33+
34+
Alternatively, Anchovy may be installed directly from source with
35+
`pip install git+https://github.com/pydsigner/anchovy` or the corresponding
36+
`pip install git+https://github.com/pydsigner/anchovy#egg=anchovy[base]`.
37+
2438
## Usage
2539

2640
Anchovy operates on config files written in Python, or even modules directly.

0 commit comments

Comments
 (0)