Skip to content

Commit 2d9d915

Browse files
aclark4lifeCopilot
andcommitted
Expand README with site structure, local preview, and contributing notes
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7bebf1d commit 2d9d915

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.rst

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,38 @@
11
Pillow Website
22
==============
33

4-
This website is live at `python-pillow.github.io <https://python-pillow.github.io/>`_
4+
This website is live at `python-pillow.github.io <https://python-pillow.github.io/>`_.
5+
6+
It's a static site — plain HTML, CSS, and a touch of vanilla JS, with no build
7+
step or framework. GitHub Pages serves it directly from the ``main`` branch.
8+
9+
Structure
10+
---------
11+
12+
- ``index.html`` — the entire site (single page)
13+
- ``assets/css/pillow.css`` — all styles
14+
- ``assets/js/back-to-top.js`` — the "back to top" button behavior
15+
- ``assets/images/`` — logos, hero art, and other images
16+
- ``assets/fontawesome/`` — vendored Font Awesome icons
17+
18+
Local preview
19+
-------------
20+
21+
Since there's no build step, any static file server works, for example::
22+
23+
python3 -m http.server 8000
24+
25+
Then open http://localhost:8000/ in a browser.
26+
27+
Contributing
28+
------------
29+
30+
This repo uses `pre-commit <https://pre-commit.com/>`_ for basic hygiene
31+
checks (trailing whitespace, end-of-file, YAML/JSON validation, etc.). Install
32+
it and run against all files with::
33+
34+
pre-commit run --all-files
35+
36+
or, if you have `just <https://github.com/casey/just>`_ installed::
37+
38+
just precommit

0 commit comments

Comments
 (0)