Skip to content

Commit 300e2b9

Browse files
committed
docs: Updates installation and roadmap docs
1 parent 4f14a31 commit 300e2b9

File tree

2 files changed

+14
-17
lines changed

2 files changed

+14
-17
lines changed

docs/01_install.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
OS | Architecture | Compiler
66
-----------------|-----------------|----------------
7-
Ubuntu 24.04 LTS | Aarch64, X86_64 | clang-19 gcc-14
7+
Ubuntu 24.04 LTS | Aarch64, X86_64 | clang-20 gcc-14
88

99
## Setup build environment
1010

1111
- Install the basic tools
1212

1313
```bash
1414
sudo apt install build-essential pkg-config gpg wget ca-certificates git-lfs curl ninja-build \
15-
ccache doxygen graphviz linux-generic python3-dev python3-pip python-is-python3 \
16-
iproute2 net-tools iftop htop nvtop
15+
ccache doxygen graphviz linux-generic python3-dev python-is-python3 pipx \
16+
iproute2 iputils-ping net-tools iftop htop nvtop
1717
```
1818

1919
- Install latest cmake and helpers
@@ -25,15 +25,16 @@ Ubuntu 24.04 LTS | Aarch64, X86_64 | clang-19 gcc-14
2525
sudo rm /usr/share/keyrings/kitware-archive-keyring.gpg
2626
sudo apt install kitware-archive-keyring
2727
sudo apt install cmake
28-
pip3 install cmake-format
28+
pipx install cmakelang
2929
```
3030

3131
- Install latest compilers
3232
- Clang
3333

3434
```bash
3535
wget https://apt.llvm.org/llvm.sh
36-
export CLANG_VERSION=19 # Replace with latest version number
36+
wget -O- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
37+
export CLANG_VERSION=20 # Replace with latest version number
3738
chmod +x llvm.sh
3839
sudo ./llvm.sh $CLANG_VERSION
3940
sudo apt install clang-$CLANG_VERSION clang-tidy-$CLANG_VERSION clang-format-$CLANG_VERSION \

docs/02_roadmap.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,13 @@
1111
- Realtime services
1212
- Serialization
1313

14-
## Dec 2024
14+
## Ongoing
1515

16+
- Switch to eCALv6 as main IPC
17+
- Teleop controller
1618
- grapecam
1719
- Implement grape::app. ([README](../modules/common/app/README.md))
1820
- Implement [grapecam](https://github.com/cvilas/grapecam)
19-
- plot
20-
- Generic plotting API and `plottable`concept
21-
- Implement PoC with [Qt6 Graphs](https://doc.qt.io/qt-6/qtgraphs-index.html)
22-
- Record and replay ([reference](https://github.com/basis-robotics/basis/tree/main/cpp/recorder))
23-
- Define behaviour for `experimental` flag in `declare_module` and implement it
24-
25-
## Jan 2025
26-
27-
- CANOpen support
28-
- Teleop controller
2921

3022
## Generalise IPC API
3123

@@ -79,8 +71,12 @@
7971
- `reinterpret_cast<uintptr_t>` from `const T*` and then modifying it later is undefined behaviour. Fix `probe::PinConfig::pin`. Consider `std::start_lifetime_as` instead.
8072
- replace `grape::realtime::SystemError` with `std::errc`
8173

82-
## 3D visualisation
74+
## Visualisation
8375

76+
- Record and replay ([reference](https://github.com/basis-robotics/basis/tree/main/cpp/recorder))
77+
- plot
78+
- Generic plotting API and `plottable`concept
79+
- Implement PoC with [Qt6 Graphs](https://doc.qt.io/qt-6/qtgraphs-index.html)
8480
- Study
8581
- [2D Game Engine](https://pikuma.com/courses/cpp-2d-game-engine-development)
8682
- [Vulkan in 30 minutes](https://renderdoc.org/vulkan-in-30-minutes.html)

0 commit comments

Comments
 (0)