Skip to content

Commit 06d4705

Browse files
committed
Update README.md with agent startup instructions
1 parent 539ab4b commit 06d4705

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,32 @@ You can either run all the 300+ tests listed in `Jamfile.v2` or run a single tes
5555
../../../b2 cycle_canceling_test <- single test
5656

5757
You can also check the [regression tests reports](http://beta.boost.org/development/tests/develop/developer/graph.html).
58+
59+
## C++20 Modernization (bgl2)
60+
61+
A modernized C++20 version of the Boost Graph Library is being developed in the [stdgraph/boost_graph](https://github.com/stdgraph/boost_graph) fork. This refactoring effort aims to bring the library up to modern C++ standards.
62+
63+
### Using the bgl2 Branch
64+
65+
To work with the modernized version, add the fork as a remote and switch to the `bgl2` branch:
66+
67+
cd libs/graph
68+
git remote add stdfork https://github.com/stdgraph/boost_graph.git
69+
git fetch stdfork
70+
git checkout bgl2
71+
git branch --set-upstream-to=stdfork/bgl2 bgl2
72+
73+
This associates your local `bgl2` branch with the fork's `bgl2` branch, so `git pull` and `git push` will use the fork by default.
74+
75+
The agents directory is located at `libs/graph/agents/` (relative to the boost root) so everything is contained in a single repository.
76+
77+
### Using an AI Agent
78+
After the repos have been set up you'll need to prime the agent with the context your working with.
79+
Enter the following in your agent's chat command line to prime the agent with the context it needs to continue the refactoring.
80+
```
81+
This project is focused on refactoring the graph library in libs/graph
82+
All agent files are in libs/graph/agents/
83+
Review libs/graph/agents/bgl_todo.md instructions to prepare for future work
84+
All refactoring output must be written under the libs/graph/modern/ directory
85+
```
86+

0 commit comments

Comments
 (0)