Merge pull request #1637 from Heus-Sueh/patch-1

Adding instructions on how to install briefcase
beeware · Feb 7, 2024 · eac7ab8 · eac7ab8
2 parents 32714c9 + 24755de
commit eac7ab8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -41,9 +41,16 @@ application. You can package projects for:
 
 Support for AppleTV, watchOS, and wearOS deployments is planned.
 
-If you want to see Briefcase in action, try the `BeeWare tutorial
-<https://beeware.readthedocs.io>`__. That tutorial walks you through the
-process of creating and packaging a new application with Briefcase.
+Getting started
+---------------
+
+To install Briefcase, run::
+
+   $ python -m pip install briefcase
+
+If you would like a full introduction to using Briefcase, try the `BeeWare tutorial
+<https://docs.beeware.io>`__. This tutorial walks you through the process of creating
+and packaging a new application with Briefcase.
 
 Documentation
 -------------

diff --git a/changes/1637.misc.rst b/changes/1637.misc.rst
@@ -0,0 +1 @@
+The installation guide in the README was clarified.