Skip to content

Commit

Permalink
Merge pull request #36 from beeware/release
Browse files Browse the repository at this point in the history
Fixes #34 - Clarifies installation and dependency instructions on Win…
  • Loading branch information
freakboy3742 committed Feb 22, 2020
2 parents 72c5776 + 96da6c2 commit 0fef7d6
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 17 deletions.
29 changes: 25 additions & 4 deletions docs/tutorial/tutorial-0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,31 @@ Install Python
==============

The first thing we'll need is a working Python interpreter, running Python 3.5
or higher. If you're on macOS or Windows, you can get the official installer
from `the Python website <https://www.python.org/downloads>`_. If you're on
Linux, you'll install Python using the system package manager (``apt`` on
Debian/Ubuntu/Mint; ``dnf`` on Fedora, or ``pacman`` on Arch).
or higher.

.. tabs::

.. group-tab:: macOS

If you're on macOS, you can get the official installer from
`the Python website <https://www.python.org/downloads>`_. You can use any
stable version of Python from 3.5 onward (although we'd advice avoiding
alphas, betas and release candidates unless you *really* know what you're
doing).

.. group-tab:: Linux

If you're on Linux, you'll install Python using the system package manager
(``apt`` on Debian/Ubuntu/Mint; ``dnf`` on Fedora, or ``pacman`` on Arch).

.. group-tab:: Windows

If you're on Windows, you can get the official installer from
`the Python website <https://www.python.org/downloads>`_. You can use any
stable version of Python 3.5, 3.6 or 3.7. We would advise *against* using
Python 3.8 at this time, as some libraries needed for this tutorial aren't
yet available for Python 3.8. We also advise avoiding alphas, betas and
release candidates unless you *really* know what you're doing.

.. admonition:: Alternative Python distributions

Expand Down
14 changes: 7 additions & 7 deletions docs/tutorial/tutorial-1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ the ``beeware-venv`` virtual environment activated, and run:

.. code-block:: bash
(beeware-venv) $ pip install --pre beeware
(beeware-venv) $ python -m pip install --pre beeware
.. group-tab:: Linux

.. code-block:: bash
(beeware-venv) $ pip install --pre beeware
(beeware-venv) $ python -m pip install --pre beeware
.. admonition:: Possible errors during installation

Expand All @@ -38,12 +38,12 @@ the ``beeware-venv`` virtual environment activated, and run:

.. code-block:: doscon
(beeware-venv)C:\...>pip install --pre beeware
(beeware-venv)C:\...>python -m pip install --pre beeware
.. admonition:: Possible errors during installation

On some versions of Python, installing the ``beeware`` package will
raise an error. This will usually manifest as:
If you're using a more recent version of Python (3.8+), installing the
``beeware`` package may raise an error. This will usually manifest as:

.. code-block:: doscon
Expand Down Expand Up @@ -94,8 +94,8 @@ the ``beeware-venv`` virtual environment activated, and run:
suggests `this collection of wheels
<https://www.lfd.uci.edu/~gohlke/pythonlibs/#pythonnet>`__ as a
possible source. The `.whl` file can be installed with
``pip install somefile.whl``; you should then be able to re-run
``pip install --pre beeware``.
``python -m pip install somefile.whl``; you should then be able to
re-run ``python -m pip install --pre beeware``.

One of the BeeWare tools is **Briefcase**. Briefcase can be used to package
your application for distribution to end users - but it can also be used to
Expand Down
12 changes: 6 additions & 6 deletions docs/tutorial/tutorial-3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ From the ``helloworld`` directory, run:
necessary to run Briefcase inside the container::

$ apt-get update
$ apt-get install python3-dev libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0
$ pip install beeware
$ apt-get install git python3-dev python3-pip libgirepository1.0-dev libcairo2-dev libpango1.0-dev libwebkitgtk-3.0-0 gir1.2-webkit-3.0
$ python3 -m pip install --pre beeware

There is no need to use a virtual environment inside the Docker
container, as Docker provides the isolation layer that virtual
Expand Down Expand Up @@ -260,7 +260,7 @@ You can now use Briefcase to run your application:
(beeware-venv) $ briefcase run
[helloworld] Starting app...
(beeware-venv) $
.. group-tab:: Linux
Expand All @@ -271,7 +271,7 @@ You can now use Briefcase to run your application:
[helloworld] Starting app...
(beeware-venv) $
(beeware-venv) $
.. group-tab:: Windows

Expand All @@ -284,7 +284,7 @@ You can now use Briefcase to run your application:
(beeware-venv) C:\...>
This will start your run your native application, using the output of the
`build` command.
`build` command.

You may notice some small differences in the way your application looks when
it's running - for example, icons, and the name displayed by the operating
Expand All @@ -293,7 +293,7 @@ mode. This is because you're using the actual packaged application, not just
running Python code. From the operating system's perspective, you're now
running "an app", not "a Python program", and that is reflected in how the
application appears. The console output we saw earlier also won't work anymore,
since we are running a standalone app that has no console to output to.
since we are running a standalone app that has no console to output to.

Building your installer
=======================
Expand Down

0 comments on commit 0fef7d6

Please sign in to comment.