Skip to content

Commit

Permalink
docs: incorporate mr-cal's suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
medubelko committed Dec 4, 2024
1 parent 1ca31f0 commit 1684dd9
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 44 deletions.
2 changes: 1 addition & 1 deletion docs/howto/craft-for-platforms/example-flutter-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ To add a Flutter part:

#. Declare the general part keys, such as ``source``, ``override-build``,
``build-packages``, and so on.
#. Set ``plugin> flutter``.
#. Set ``plugin: flutter``.
#. If the part is the main app, set ``flutter-target`` to the location of the
project's ``main.dart`` file.
19 changes: 0 additions & 19 deletions docs/howto/craft-for-platforms/example-python-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,6 @@ The process of developing a snap for a Python app builds on top of standard
Python packaging tools and configuration, making it possible to adapt or
integrate an app's existing build tooling into the crafting process.

Python projects that follow `PEP 517 <https://peps.python.org/pep-0517/>`_ and
have a ``pyproject.toml`` must be packed with the ``edge`` channel of
Snapcraft.

To switch your existing Snapcraft installation to the ``edge`` channel, run:

.. code:: bash
sudo snap refresh snapcraft --edge
To install a parallel copy of Snapcraft with the ``edge`` channel, run:

.. code:: bash
sudo snap install snapcraft snapcraft_edge --edge
To run the copy, use ``snapcraft_edge`` as the command name.


Example recipe for liquidctl
----------------------------
Expand Down
26 changes: 2 additions & 24 deletions docs/howto/craft-for-platforms/example-ros-2-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,20 +217,6 @@ The warnings regarding missing libraries that you might see when building your
snap are false positive. These libraries are build time dependencies only.


core22
~~~~~~

Due to a bug in the current version of Snapcraft, you won't be prompted to
first install LXD if it's not already installed, causing Snapcraft to hang
indefinitely.

To install and initialise LXD, run:

.. code:: bash
sudo snap install lxd && sudo lxd init --auto`
Share content between ROS 2 snaps
---------------------------------

Expand Down Expand Up @@ -311,9 +297,8 @@ To turn on content sharing:
<https://snapcraft.io/docs/ros2-jazzy-content-extension>`_


Before launching the app for the first time, you must connect the .
Since our snap makes use of the content provided by another snap, we have to
connect them.
Because the snap makes use of the content provided by another snap, you must
connect them through an interface before you can test the app.

To connect the snaps:

Expand All @@ -332,10 +317,3 @@ To connect the snaps:
If the connection is successful, the output will show that through the
content interface, the snap's ROS launch command is manually plugged in to
the ROS base snap.

Lastly, the content-sharing extension is experimental. Before you can build a
snap that uses it, you must enable experimental extensions in your terminal:

.. code:: bash
SNAPCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=1

0 comments on commit 1684dd9

Please sign in to comment.