Update docs

README.md

@@ -1,54 +1,45 @@
-# bitbots_meta
 
-This git repository contains all RoboCup-related code and documentation from the Hamburg Bit-Bots team as git submodules.
-All code is written as ROS 2 packages for ROS 2 on Ubuntu.
+
+# Bit-Bots Software Stack
 
 [![Test if all packages build](https://github.com/bit-bots/bitbots_meta/actions/workflows/build.yml/badge.svg)](https://github.com/bit-bots/bitbots_meta/actions/workflows/build.yml)
 
-## Installation
+This git repository contains all RoboCup-related code and documentation from the Hamburg Bit-Bots team.
+All code is written as individual ROS 2 packages targeting Ubuntu.
 
-Full step-by-step instructions for installing the Bit-Bots software stack and ROS 2 can be found in our documentation [here](https://doku.bit-bots.de/meta/manual/tutorials/install_software_ros2.html).
+<p align="center">
+  <img width="30%" src="logo.png" alt="marimba playing robot" />
+</p>
 
-To download the Bit-Bots software stack clone this repository.
+## Installation
 
-```bash
-git clone [email protected]:bit-bots/bitbots_meta.git
-```
+Full step-by-step instructions for installing the Bit-Bots software stack and ROS 2 can be found in our documentation [here](https://doku.bit-bots.de/meta/manual/tutorials/install_software_ros2.html).
 
-The meta repository mainly contains references (submodules) to other repositories for the different components of the codebase.
-Download them run the following commands.
-
-```bash
-cd bitbots_meta
-make pull-init
-```
 
 ## Update the codebase
 
-If you want to update all submodules, this repo, and supplementing files, run
+If you want to update this repo, all third party source files as well as the supplementing files, run
 
 ``` bash
 make pull-all
 ```
 
-Make sure you are on the correct branch and have no uncommitted changes in each submodule.
-To check this run
+If you encounter any problems consider cleaning the third party source files (the `lib` folder) first:
 
-```bash
-make status
-```
+**THIS DELETES ALL CHANGES YOU MADE TO THE THIRD PARTY SOURCE FILES**
 
-Other scripts are available in the `scripts` folder, [documented here](scripts/README.md).
+``` bash
+make fresh-libs
+```
 
-## Repository Structure
+## Run auto formatting
 
-The naming prefix of submodules indicates the scope of the packages.
+To format all code in the repository, run
 
-* bitbots_ : specific RoboCup code of our team
-* humanoid_league_ : packages which are useful for all teams in the RoboCup Humanoid League, e.g. visualization tools and game controller
-* no prefix : packages which are useful in general and usable outside of RoboCup
-* lib : folder for third party libraries that need to be build from source
+``` bash
+make format
+```
 
-## Documentation
+## More documentation
 
 Our documentation is hosted on [docs.bit-bots.de](https://docs.bit-bots.de/).

bitbots_misc/bitbots_docs/docs/manual/tutorials/cl_simulation_testing_setup.rst

@@ -22,8 +22,7 @@ As such you can lookup some of the needed requirements there.
   mkdir -p "~/colcon_ws/src"
   cd "~/colcon_ws/src"
   git clone [email protected]:bit-bots/bitbots_meta.git && cd bitbots_meta
-  make pull-init
-  pip install -r bitbots_meta/requirements/dev.txt
+  make install-no-root
 
 - set PATH and COLCON_WS (see `section 5 <https://docs.bit-bots.de/meta/manual/tutorials/install_software_ros2.html>`_)
 

bitbots_misc/bitbots_docs/docs/manual/tutorials/configure_and_flash_robot.rst

@@ -41,8 +41,9 @@ At a competition, follow these steps:
 #. **Checkout the latest code:**
    In your local `bitbots_meta <https://github.com/bit-bots/bitbots_meta>`_ repo run:
 
-   #. ``make status`` to check if the submodules are on the correct branch (normally ``master`` or ``main``)
-   #. ``make pull-all`` to update all submodules
+   #. Check that you are on the ``master`` branch
+   #. ``git pull`` to get the latest changes
+   #. ``make fresh-libs`` to clean and update all third party libraries
 
 #. **Sync, configure, compile and launch software:**
    In the ``bitbots_meta`` directory call the ``deploy_robots.py`` tool:
@@ -120,7 +121,7 @@ We utilize a python script located in ``bitbots_meta/scripts/robot_compile.py``
 - sync the local code of the whole ``bitbots_meta`` or a single package onto a robot
 - build the synced code on the robot afterwards
 - automatically install required dependencies with ``rosdep install`` if the robot has an active internet connection
-- clean the whole ``~/colcon_ws`` on a robot 
+- clean the whole ``~/colcon_ws`` on a robot
 - interactively configure the ``game_settings.yaml`` on a robot to prepare it for a game
 - activate the fields Wi-Fi connection and disable all others
 

bitbots_misc/bitbots_docs/docs/manual/tutorials/install_software_ros2.rst

@@ -37,9 +37,9 @@ If you are not already using Ubuntu 22.04, consider installing it on your system
 
 **3. Download our software**
 
-- Create a GitHub and Mafiasi account, if not already done (see here for further information on this: http://doku.bit-bots.de/private/manual/dienste_accounts.html)
+- Create a GitHub account, if not already done (see here for further information on this: http://doku.bit-bots.de/private/manual/dienste_accounts.html)
   Those services host our Git software repositories.
-- Add your SSH key to GitHub and Gitea to access and sync our repositories
+- Add your SSH key to GitHub to access and sync our repositories
     - If you don't know what I am talking about or you don't yet have a SSH key, follow this guide: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys
     - Go to your account settings and add your SSH key (the ``.pub`` file) for `GitHub <https://github.com/settings/keys>`_ AND `Gitea <https://git.mafiasi.de/user/settings/keys>`_
 - Now, you can clone (download) our main code repository (repo) called `bitbots_meta <https://github.com/bit-bots/bitbots_meta>`_:
@@ -50,11 +50,9 @@ If you are not already using Ubuntu 22.04, consider installing it on your system
     - Clone the code repository with: ``git clone [email protected]:bit-bots/bitbots_meta.git``
       Confirm the host key by typing ``yes``, if asked.
     - Move into the newly created directory with: ``cd bitbots_meta``
-    - Clone all sub-repositories and other files by running: ``make install``
+    - Clone all code and other files by running: ``make install``
       This will take a while, as it downloads all the code and other files from our repositories and additionally installs all missing dependencies (using rosdep and pip).
       Finally, it will register pre-commit hooks (automatic code-formatting and warnings), which will be run every time you commit code to our repositories.
-    - To use the robot's cameras, also run the following command to download and install the Basler Pylon camera drivers: ``make basler``
-      Confirm with the properitary license agreement by typing ``y``, and later enter your passwort (sudo) if asked.
 
 **4. Setup colcon workspace**