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

Overhaul README.md #108

Merged
merged 31 commits into from
Sep 17, 2020
Merged

Overhaul README.md #108

merged 31 commits into from
Sep 17, 2020

Conversation

apollokit
Copy link
Collaborator

This:

  • merges in the stuff from the software steps document in the main repo
  • Incorporates my updates from getting Ubuntu 18.04 up and going on the rover

Not ready for merge yet, need #107 to be merged first and to reconcile my changes here with that.

@apollokit
Copy link
Collaborator Author

Note that I made Ubuntu 18.04 the recommended default OS. Are we happy with that?

@Achllle Achllle self-requested a review August 3, 2020 05:24
@apollokit apollokit marked this pull request as draft August 3, 2020 05:24
Copy link
Collaborator

@Achllle Achllle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I made a few comments. We'll have to open up a PR in the open-source-rover repo to refer to documentation here instead

scripts/roboclawtest.py Outdated Show resolved Hide resolved
scripts/make_readme_pdf.sh Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@gfosmire
Copy link
Collaborator

gfosmire commented Aug 3, 2020

Wow Kit great work, thanks for putting the time into this. I haven't had a chance to go over everything you've done here, but this looks like a great first step in fixing and making the readme more usable.

@apollokit
Copy link
Collaborator Author

Per my comment above, I need to vet all this again on a clean SD card. Didn't have time to do this weekend.

@apollokit
Copy link
Collaborator Author

Also, need to address the RPi user name in the instructions...does it have to be "ubuntu"?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
apollokit and others added 2 commits August 9, 2020 18:10
…erything through brining up and driving the rover, so the content should be good now.
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
@apollokit apollokit marked this pull request as ready for review August 18, 2020 06:09
@apollokit
Copy link
Collaborator Author

@Achllle , @ericjunkins , @gfosmire, I'm done with major work on this, I think. Needs review from you gentlemen. Would be best too if at least one person could go through all the setup steps along the 18.04 path and confirm they work for you. I've done it all myself again, per the instructions here, but always possible that I assumed or skipped something inadvertently.

Note that I've baked in 18.04 as the default now. I haven't taken the time myself to verify remote desktop functionality (as was mentioned before), but my understanding is that it's well-supported on 18.04, given that you're willing to install all the desktop components (I don't really want to on my Ubuntu server image). I have confirmed that X11 forwarding works though, via ssh -X ubuntu@pi-ip-addr

@ericjunkins
Copy link
Collaborator

@apollokit I ran through these instructions today up having all the catkin directories etc setup on the pi, and the following are a few notes I have

  • Instructions at 3.2: Clone and build the rover code should have you cd .. to leave the src directory so that catkin_make works

  • One thing also we might want to link to is instead of an ubuntu server image that then they can install a desktop version on, could also supply the link to the ubuntu mate page, the lack of a desktop can be daunting for a first-time user. https://ubuntu-mate.org/ports/raspberry-pi/

  • We should be careful saying download the 64 bit version even for the server ubuntu 18.04, I thought I read that that won't work with older version of the rpi, like a 3b etc.

Copy link
Collaborator

@Achllle Achllle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With these suggestions I think this will be ready to go in. Tested these on Ubuntu20.04

setup/rover_bringup.md Outdated Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
config/serial_udev_ubuntu1804.rules Show resolved Hide resolved
setup/rpi.md Outdated Show resolved Hide resolved
setup/rpi_raspbian.md Show resolved Hide resolved
setup/rpi_raspbian.md Show resolved Hide resolved
apollokit and others added 3 commits September 14, 2020 22:34
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
@apollokit
Copy link
Collaborator Author

@ericjunkins covered all your points for above in commit 3de57a8. I added Ubuntu Mate as the default. But I cannot tell a lie...I have not gone through all the steps with Mate like I did with the server image.

@Achllle
Copy link
Collaborator

Achllle commented Sep 15, 2020

Hold on - why install Ubuntu Mate if we can just use Ubuntu + GNOME or some other desktop? To get the desktop, all you would need to do is add a few extra lines. See for example here

@apollokit
Copy link
Collaborator Author

Hold on - why install Ubuntu Mate if we can just use Ubuntu + GNOME or some other desktop? To get the desktop, all you would need to do is add a few extra lines. See for example here

Yeah agreed, that's a better approach. I'll put that in the instructions, and remove the Ubuntu Mate stuff.

@apollokit
Copy link
Collaborator Author

Ok, I think this is pretty much polished off. Still testing installing a GNOME GUI on my rpi at the moment, will confirm after that's done. At that point I think this'll be ready to go.

@apollokit
Copy link
Collaborator Author

Confirmed the GNOME GUI works after installing on ubuntu server. Think this is ready to go now.

apollokit and others added 5 commits September 16, 2020 16:58
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
Co-authored-by: Achille Verheye <achille.verheye@gmail.com>
@apollokit
Copy link
Collaborator Author

Whoops, hadn't resolved some of Achille's stuff. Think it's all done now. At least, from what I can tell.

Copy link
Collaborator

@Achllle Achllle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work, thanks again!

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.

None yet

4 participants