Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md, made a link to the official Installation Guide for 2.9 #271

Merged
merged 5 commits into from
Sep 12, 2018

Conversation

kaixqu
Copy link
Contributor

@kaixqu kaixqu commented Sep 12, 2018

The old README is deprecated. The newest one should be the first thing users see to help them install rtt easily.

@meyerj meyerj merged commit 68b7025 into orocos-toolchain:master Sep 12, 2018
@meyerj
Copy link
Member

meyerj commented Sep 12, 2018

Thanks for the update. Indeed the old README was outdated. The referenced installation manual at https://orocos-toolchain.github.io/rtt/toolchain-2.9/xml/orocos-installation.html is also partially out of date, but still better to reference this one than to replicate the manual in a README.

Also note that we once started to create a new installation manual and script (for non-ROS users) at the Orocos Toolchain level in orocos-toolchain/orocos_toolchain#13, but there are still some "to be copied from..." sections. The ultimate goal is to update and convert all the documents from https://github.com/orocos-toolchain/rtt/tree/master/doc to MarkDown or reStructuredText and host it using GitHub pages (like https://orocos-toolchain.github.io) or Read The Docs. This could also replace the Orocos wiki on http://www.orocos.org/, which still has some useful, but mainly outdated content.

Unfortunately there is no time at the moment to follow up on this, but any contribution towards that goal is highly appreciated.

@kaixqu
Copy link
Contributor Author

kaixqu commented Sep 12, 2018

Could you please look at orocos-toolchain/orocos_toolchain#30 and give me a little hint.

Now I succeed in installing rtt following its installation guide, then log4cpp following rtt's instruction, then ocl following rtt's instruction. But when I tried to create my first package, HelloWorld. It seems I still need to install orogen. And that's where I got stuck. Installing these packages are really painful, I would really love to install orocos-toolchain as a whole.

I will write down a documentation about how to install them and help others, if I succeed! Thank you in advance! :-)

@meyerj

meyerj pushed a commit that referenced this pull request Apr 11, 2019
…2.9 (#271)

* Update README
* Rename README to README.md
francisco-miguel-almeida pushed a commit that referenced this pull request Apr 12, 2019
…2.9 (#271)

* Update README
* Rename README to README.md
meyerj added a commit that referenced this pull request Apr 17, 2019
... and convert/update/delete other top-level text files to Markdown.

Partially reverts #271 and restores the original README from branch master

reStructuredText has been chosen for the Changelog for compliance with http://www.ros.org/reps/rep-0132.html.
meyerj added a commit that referenced this pull request Apr 17, 2019
... and convert/update/delete other top-level text files to Markdown.

Partially reverts #271 and restores the original README from branch master

reStructuredText has been chosen for the Changelog for compliance with http://www.ros.org/reps/rep-0132.html.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants