Create user guide for M1

[gavanderhoorn]

This document should describe how to:

• install the tool
• start the tool
• setup a catkin workspace (could potentially link to existing documentation on the ROS wiki)
• create a urdf from scratch
• load an existing urdf / xacro
• edit a model
• save a model (to urdf, to xacro macro, to robot support package)

[gavanderhoorn]

This could be a pdf, or a (set of) page(s) on the ROS wiki or the wiki of this repository.

[ShawnSchaerer]

Do we want this for next week?
I will start a word document. Where should I store it?

[gavanderhoorn]

Do we want this for next week?

Ideally, yes.

I will start a word document. Where should I store it?

Would you be ok with it not being a word document? Or would that be just for you personally to work in? A more open -- and versionable -- format might be preferable.

@phvass: opinion?

[ShawnSchaerer]

other formats are fine, I just don't want to fight with formatting. we
could do it in HTML or some other system.

On Thu, Apr 21, 2016 at 2:45 PM, G.A. vd. Hoorn [email protected]
wrote:

Do we want this for next week?

Ideally, yes.

I will start a word document. Where should I store it?

Would you be ok with it not being a word document? Or would that be
just for you personally to work in? A more open -- and versionable --
format might be preferable.

@phvass https://github.com/phvass: opinion?

—
You are receiving this because you were assigned.
Reply to this email directly or view it on GitHub
#54 (comment)

[gavanderhoorn]

Well we already have a wiki, and many of the supported formats there can also be rendered to a pdf (using pandoc fi).

[ShawnSchaerer]

I can do it on the wiki. if someone gets me access.

On Thu, Apr 21, 2016 at 3:01 PM, G.A. vd. Hoorn [email protected]
wrote:

Well we already have a wiki, and many of the supported formats there can
also be rendered to a pdf (using pandoc fi).

—
You are receiving this because you were assigned.
Reply to this email directly or view it on GitHub
#54 (comment)

[gavanderhoorn]

I've unchecked Restrict editing to users in teams with push access only, so everyone should be able to edit the wiki now.

Or at least: everyone with access to the repository.

[gavanderhoorn]

Note btw that github wikis are git repositories as well. You don't need to edit everything through your web browser.

[swhart115]

Github lets you create "Github Pages" websites for your projects as well
that are separate from the wiki.

[gavanderhoorn]

@swhart115 wrote:

Github lets you create "Github Pages" websites for your projects as well
that are separate from the wiki.

Yes, but those are not private (from What are GitHub Pages?):

Warning: GitHub Pages sites are publicly available on the internet, even if their repositories are private. If you have sensitive data in your Page repository, you may want to remove it before publishing.

[ShawnSchaerer]

Are all of the features now in for this release?

[gavanderhoorn]

Features - yes. There might be bug fixes, but that will probably not change the intended behaviour of the features.

What do you intend to include in the guide?

[ShawnSchaerer]

building, install and basic usability.

On Thu, May 19, 2016 at 2:59 PM, G.A. vd. Hoorn [email protected]
wrote:

Features - yes. There might be bug fixes, but that will probably not
change the intended behaviour of the features.

What do you intend to include in the guide?

—
You are receiving this because you were assigned.
Reply to this email directly or view it on GitHub
#54 (comment)

[gavanderhoorn]

Ok. Make sure to check out the wiki/Development page for "building and install" if you hadn't already.

[phvass]

Seems like the focus should be on usability, since the wiki already covers build and install...

[ShawnSchaerer]

Ok.

Sent from my iPhone

On May 20, 2016, at 10:06 AM, Paul Hvass [email protected] wrote:

Seems like the focus should be on usability, since the wiki already covers build and install...

—
You are receiving this because you were assigned.
Reply to this email directly or view it on GitHub