Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
rishiso committed Jan 23, 2025
1 parent 178b9d8 commit 78d40ba
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ ENV LANG en_US.UTF-8
COPY . ~/robocup-software
WORKDIR ~/robocup-software

RUN sudo ./util/ubuntu-setup --yes --no-submodules
RUN sudo ./util/ubuntu-setup --yes --no-submodules
8 changes: 3 additions & 5 deletions Dockerfile.dev
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# The image has been pushed to rishiso/robocup-software:latest on DockerHub
# Please read https://hub.docker.com/repository/docker/rishiso/robocup-software/general for usage

# Use the official Ubuntu 22.04 image
FROM ubuntu:22.04

Expand Down Expand Up @@ -73,7 +70,8 @@ RUN git clone https://github.com/robotics-erlangen/framework.git /root/framework

# Use bash to source the ROS2 setup file and run make perf
RUN bash -c "source /opt/ros/humble/setup.bash && \
cd /root/robocup-software && make perf && \
cd /root/robocup-software && \
make perf && \
source install/setup.bash"

# Install external ref (conditionally download the correct binary based on architecture)
Expand All @@ -95,4 +93,4 @@ CMD ["/bin/bash", "-c", "\
echo 'password' | vncpasswd -f > /root/.vnc/passwd && \
chmod 600 /root/.vnc/passwd && \
vncserver :1 -geometry 1920x1080 -depth 24 && \
/opt/noVNC/utils/novnc_proxy --vnc localhost:5901 --listen 6080"]
/opt/noVNC/utils/novnc_proxy --vnc localhost:5901 --listen 6080"]
26 changes: 17 additions & 9 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@ Installation
If you are completely unfamiliar with the command line or basic git
usage, see the Tutorial page before proceeding.

Virtual Machine Setup
---------------------
There are two main ways to install our software. The first is use a native
or virtual machine running Ubuntu 22.04, and the second is to use Docker.
The Docker method is recommended for Mac users.


Native/Virtual Machine Setup
----------------------------

We only provide official support for Ubuntu 22.04 due to ROS2. Make sure you
are on an Ubuntu 22.04 machine before continuing. For Windows users, using WSL2
with Ubuntu 22.04 will work. The steps to set this up can be found `here
Expand Down Expand Up @@ -123,22 +129,24 @@ simulator, plus a UI to show what's happening, run the following:
If everything is working properly, you should see the following window show up.

.. image::
.. image:: ./_static/soccer.png

./_static/soccer.png

Docker Setup
------------
Instead of using a virtual machine, you can also install our software using Docker.
The Docker image has our tech stack and all the dependencies pre-installed with
a desktop GUI. The Docker setup should work on any platform (Windows, Mac, ARM, AMD, etc.).
----------------------------

Instead of using an Ubuntu 22.04 machine, you can also install our software using our Docker
image that runs Ubuntu 22.04. The Docker image also has our tech stack and all the dependencies
pre-installed with a desktop GUI. The Docker setup should work on any platform
(Windows, Mac, ARM, x86, etc.).

Before you start, make sure you have Docker installed on your computer. The steps for doing
so can be found at https://docs.docker.com/engine/install/.

Once you have Docker installed, please follow the steps for installing and using our RoboCup
image at `DockerHub
<https://hub.docker.com/r/robojackets/robocup-software>`_.
<https://hub.docker.com/r/robojackets/robocup-software-dev>`_.


Shortcuts
---------
Expand Down

0 comments on commit 78d40ba

Please sign in to comment.