Add a tutorial for turning a ROS project into a .snap. #159

Merged
merged 1 commit into from Dec 10, 2015

Conversation

Projects
None yet
3 participants
Member

kyrofa commented Dec 7, 2015

No description provided.

+## Package your current ROS project as a .snap
+
+Let's assume you already have a ROS project. It can be as simple or as
+complicated as you like, but for this example, our project will be made up of:
@elopio

elopio Dec 7, 2015

Member

would it be good to mention the project in the examples dir as a reference?

@kyrofa

kyrofa Dec 8, 2015

Member

I actually plan on replacing that example with a more realistic one when I have a better solution for roscore.

docs/ros-snap.md
+```yaml
+name: ros-talker-and-listener
+version: 1.0
+vendor: example <example@example.com>
@elopio

elopio Dec 7, 2015

Member

no vendor anymore.

@kyrofa

kyrofa Dec 8, 2015

Member

Removed, thank you.

docs/ros-snap.md
+vendor: example <example@example.com>
+summary: ROS Example
+description: Contains talker/listener ROS packages and a .launch file.
+icon: icon.svg
@elopio

elopio Dec 7, 2015

Member

icon is optional, so I would leave it out of the examples, for brevity.

@kyrofa

kyrofa Dec 8, 2015

Member

Ah, right.

docs/ros-snap.md
+`rosrun` or `roslaunch`. Instead, you have control over how your .snap is used,
+and here we specify that we only want a single binary, called "launch_project",
+which results in the `roslaunch` call you see. If this seems confusing now, it
+might make more sense when we actually use it.
@elopio

elopio Dec 7, 2015

Member

nitpicking here, I think you should mention that we'll give it a try later in the document.
"it WILL make more sense later in this document when we actually use it."

@kyrofa

kyrofa Dec 8, 2015

Member

Agreed, good point.

docs/ros-snap.md
+
+ $ ros-talker-and-listener.launch_project
+
+And you should see the talker and listener communicating like before.
@elopio

elopio Dec 7, 2015

Member

How to stop them?

@kyrofa

kyrofa Dec 8, 2015

Member

ctrl+c, I updated it to reflect, thank you :) .

Member

elopio commented Dec 7, 2015

Thanks @kyrofa, this is great.
I'd like @dholbach to take a look, so we make sure we are consistent with the style in his docs.

+ ...
+
+### Put it all in a .snap
+
@dholbach

dholbach Dec 8, 2015

Contributor

Maybe add half a sentence about what snapcraft.yaml is, what snapcraft aims to do - just so people who get directed to this specific article have a little bit of context.

@kyrofa

kyrofa Dec 8, 2015

Member

Done. Does that look better?

@dholbach

dholbach Dec 8, 2015

Contributor

+1 - great work!

docs/ros-snap.md
+
+ $ sudo snappy install ros-talker-and-listener_1.0_amd64.snap \
+ --allow-unauthenticated
+
@dholbach

dholbach Dec 8, 2015

Contributor

Is snappy-remote maybe easier to use or explain?

@kyrofa

kyrofa Dec 8, 2015

Member

Probably. I've updated the document to use snappy-remote. Does that seem simpler?

Add a tutorial for turning a ROS project into a .snap.
Signed-off-by: Kyle Fazzari <kyle@canonical.com>
Member

elopio commented Dec 10, 2015

I think the last comment by @dholbach means he's happy, so let's merge.

elopio added a commit that referenced this pull request Dec 10, 2015

Merge pull request #159 from kyrofa/add_catkin_plugin_documentation
Add a tutorial for turning a ROS project into a .snap.

@elopio elopio merged commit 3b9b04c into snapcore:master Dec 10, 2015

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 95.771%
Details

@kyrofa kyrofa deleted the kyrofa:add_catkin_plugin_documentation branch Dec 21, 2015

kalikiana pushed a commit to kalikiana/snapcraft that referenced this pull request Apr 6, 2017

Merge pull request #159 from kyrofa/add_catkin_plugin_documentation
Add a tutorial for turning a ROS project into a .snap.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment