diff --git a/Readme.md b/Readme.md index 083129a..153b43d 100644 --- a/Readme.md +++ b/Readme.md @@ -1,14 +1,19 @@ -# Pythonlings - -[![PyPI](https://img.shields.io/pypi/v/pythonlings)](https://pypi.org/project/pythonlings/) -[![Python](https://img.shields.io/pypi/pyversions/pythonlings)](https://pypi.org/project/pythonlings/) -[![CI](https://github.com/abhiksark/pythonlings/actions/workflows/ci.yml/badge.svg)](https://github.com/abhiksark/pythonlings/actions/workflows/ci.yml) -[![Downloads](https://img.shields.io/pypi/dm/pythonlings)](https://pypi.org/project/pythonlings/) -[![License: MIT](https://img.shields.io/badge/license-MIT-yellow)](LICENSE) + +

+ Pythonlings: Learn Python by fixing tiny broken programs. +

+ +

+ PyPI package version + Supported Python versions + Continuous integration status + Monthly PyPI downloads + MIT license +

Documentation: [pythonlings.abhik.ai](https://pythonlings.abhik.ai/) -**Rustlings for Python — learn by fixing 292 tiny broken programs in your terminal.** +**Learn Python by fixing tiny broken programs.** Pythonlings helps you learn Python by fixing small broken programs and watching checks rerun as you type. It is built for beginner Python practice, coding diff --git a/docs-site/assets/favicon.png b/docs-site/assets/favicon.png new file mode 100644 index 0000000..07e3119 Binary files /dev/null and b/docs-site/assets/favicon.png differ diff --git a/docs-site/assets/favicon.svg b/docs-site/assets/favicon.svg deleted file mode 100644 index c388527..0000000 --- a/docs-site/assets/favicon.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - - diff --git a/docs-site/assets/logo.png b/docs-site/assets/logo.png new file mode 100644 index 0000000..c054493 Binary files /dev/null and b/docs-site/assets/logo.png differ diff --git a/docs-site/assets/logo.svg b/docs-site/assets/logo.svg deleted file mode 100644 index 62e18e8..0000000 --- a/docs-site/assets/logo.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - diff --git a/docs/assets/branding/pythonlings-hero.png b/docs/assets/branding/pythonlings-hero.png new file mode 100644 index 0000000..0e5d4d8 Binary files /dev/null and b/docs/assets/branding/pythonlings-hero.png differ diff --git a/docs/assets/branding/pythonlings-logo-monochrome.png b/docs/assets/branding/pythonlings-logo-monochrome.png new file mode 100644 index 0000000..2fade0b Binary files /dev/null and b/docs/assets/branding/pythonlings-logo-monochrome.png differ diff --git a/docs/assets/branding/pythonlings-logo.png b/docs/assets/branding/pythonlings-logo.png new file mode 100644 index 0000000..4498c55 Binary files /dev/null and b/docs/assets/branding/pythonlings-logo.png differ diff --git a/docs/assets/branding/pythonlings-mascot.png b/docs/assets/branding/pythonlings-mascot.png new file mode 100644 index 0000000..3e840b8 Binary files /dev/null and b/docs/assets/branding/pythonlings-mascot.png differ diff --git a/docs/assets/demos/pythonlings-demo.gif b/docs/assets/demos/pythonlings-demo.gif index f7d345d..75cd368 100644 Binary files a/docs/assets/demos/pythonlings-demo.gif and b/docs/assets/demos/pythonlings-demo.gif differ diff --git a/docs/assets/screenshots/coding-screen.png b/docs/assets/screenshots/coding-screen.png index 6a654d3..d2e1530 100644 Binary files a/docs/assets/screenshots/coding-screen.png and b/docs/assets/screenshots/coding-screen.png differ diff --git a/docs/assets/screenshots/docs-reference.png b/docs/assets/screenshots/docs-reference.png index e0a6b8f..e0c3251 100644 Binary files a/docs/assets/screenshots/docs-reference.png and b/docs/assets/screenshots/docs-reference.png differ diff --git a/docs/assets/screenshots/topic-picker.png b/docs/assets/screenshots/topic-picker.png index 96c1e6c..843e1d9 100644 Binary files a/docs/assets/screenshots/topic-picker.png and b/docs/assets/screenshots/topic-picker.png differ diff --git a/docs/demo.tape b/docs/demo.tape index d809f80..5838d93 100644 --- a/docs/demo.tape +++ b/docs/demo.tape @@ -1,3 +1,4 @@ +# docs/demo.tape Output docs/assets/demos/pythonlings-demo.gif Set Shell "bash" @@ -22,6 +23,10 @@ Type "pythonlings" Enter Sleep 3s +# Dismiss first-run onboarding, then let the coding screen settle. +Enter +Sleep 500ms + # Coding screen -> local Python reference (F5), then close it (Esc) Escape Type@0ms "[15~" diff --git a/mkdocs.yml b/mkdocs.yml index c9a59d2..ee6d784 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,4 @@ +# mkdocs.yml site_name: Pythonlings site_url: https://pythonlings.abhik.ai/ site_description: Python learnings, Rustlings-style, in a terminal TUI. @@ -9,8 +10,8 @@ docs_dir: docs-site theme: name: material language: en - logo: assets/logo.svg - favicon: assets/favicon.svg + logo: assets/logo.png + favicon: assets/favicon.png font: text: Inter code: JetBrains Mono