Skip to content

Commit 0469336

Browse files
authored
[readme] Update README for version 2.3.x (#460)
1 parent 2aca441 commit 0469336

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
1-
# Py Trees
1+
# PyTrees
22

33
[[About](#about)] [[What's New?](#whats-new)] [[Documentation](#documentation)] [[Getting Started](#getting-started)] [[Next Steps](#next-steps)] [[Releases](#releases)]
44

55
----
66

77
## About
88

9-
PyTrees is a python implementation of behaviour trees designed to facilitate the rapid development of medium sized decision making engines for use in fields like robotics. Brief feature list:
9+
PyTrees is a Python implementation of behaviour trees designed to facilitate the rapid development of medium sized decision making engines for use in fields like robotics.
10+
11+
Brief feature list:
1012

1113
* Behaviours, Decorators, Sequences, Selectors, Parallels and BehaviourTree.
1214
* Blackboards for data sharing.
13-
* A useful library of behaviours, decorators and idioms.
15+
* A useful library of behaviours, decorators, and idioms.
1416
* Serialise to a dot graph or render to ascii/unicode in a terminal.
1517
* Tested on Linux and Mac (YMMV with Windows).
1618

1719
## What's New?
1820

19-
* [2023-01-28] The [2.2.x Release][new-2.2.x] is out! Sequences and Selectors with AND without memory.
20-
* [2023-01-28] [Get Started](#getting-started) with py_trees in under 5mins.
21-
* [2023-01-28] This is now a `poetry` project with configuration governed by `pyproject.toml`.
22-
* The vestigial `setup.py` is only to assist distribution where [PEP-517](https://peps.python.org/pep-0517/) is not yet well supported.
21+
* [2025-01-11] Support for Python 3.12 was added, and Python 3.8 was dropped.
2322

2423
## Documentation
2524

26-
[![devel][docs-devel-image]][docs-devel] [![2.2.x][docs-2.2.x-image]][docs-2.2.x] [![2.1.x][docs-2.1.x-image]][docs-2.1.x] [![0.7.x][docs-0.7.x-image]][docs-0.7.x] [![0.6.x][docs-0.6.x-image]][docs-0.6.x]
25+
[![devel][docs-devel-image]][docs-devel] [![2.3.x][docs-2.3.x-image]][docs-2.3.x] [![2.2.x][docs-2.2.x-image]][docs-2.2.x] [![2.1.x][docs-2.1.x-image]][docs-2.1.x]
2726

2827
## Getting Started
2928

30-
You can get started on CodeSpaces (with no mismatched environment issues and in under 5mins) [1]:
29+
You can get started on Codespaces (with no mismatched environment issues and in under 5 minutes) [1]:
3130

3231
1. Fork the project to your personal account
3332
2. Click on Code -> Codespaces -> + Create a Codespace
@@ -65,8 +64,8 @@ py310 py312 format check mypy310 mypy312
6564
# https://github.com/splintered-reality/py_trees/blob/devel/CONTRIBUTING.md
6665
```
6766

68-
[1] All of the above will, of course, work in a local environment if you have `poetry` installed. If you're using `VSCode`
69-
you don't even need that, just reopen the project in the [devcontainer](.devcontainer/devcontainer.json) and be froody.
67+
[1] All of the above will, of course, work in a local environment if you have `poetry` installed.
68+
If you're using `VSCode` you don't even need that, just reopen the project in the [devcontainer](.devcontainer/devcontainer.json) and be froody.
7069

7170
## Next Steps
7271

@@ -75,7 +74,7 @@ On PyPi:
7574
* [py_trees_js](https://pypi.org/project/py-trees-js/)
7675

7776
Examples:
78-
* [ReadTheDocs - PyTrees ROS Tutorials](https://py-trees-ros-tutorials.readthedocs.io/en/release-2.0.x/index.html) - significantly more edifying than the demos, these incrementally walk through the process of building a decision making layer for a robot. These use ROS2 (sparsely), but merely browsing should be enlightening regardless.
77+
* [ReadTheDocs - PyTrees ROS Tutorials](https://py-trees-ros-tutorials.readthedocs.io/en/devel/index.html) - significantly more edifying than the demos, these incrementally walk through the process of building a decision making layer for a robot. These use ROS2 (sparsely), but merely browsing should be enlightening regardless.
7978

8079
Visualisation:
8180
* [py_trees_js](https://github.com/splintered-reality/py_trees_js) - a javascript library for building your own runtime visualisation tool
@@ -86,6 +85,7 @@ Robotics:
8685

8786
## Releases
8887

88+
* `2.3.x` - Support for Python 3.12 was added, and Python 3.8 was dropped.
8989
* `2.2.x` - Selectors, Sequences with and without memory. Improved testing and style/type checking.
9090
* `2.1.x` - Chooser deprecated. API housekeeping.
9191
* `2.0.x` - Blackboards V2!
@@ -94,12 +94,12 @@ Robotics:
9494
* `1.0.x` - Behaviours, Decorators, Composites, Blackboards, Tree Management and Viz tools.
9595
* `0.y.x` - First open source pre-releases.
9696

97-
| | Devel | 2.2.x | 2.1.x | 2.0.x | 1.2.x | 0.7.x | 0.6.x |
98-
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
99-
| Sources | [![devel][sources-devel-image]][sources-devel] | [![2.1.x][sources-2.2.x-image]][sources-2.2.x] | [![2.1.x][sources-2.1.x-image]][sources-2.1.x] | [![2.0.x][sources-2.0.x-image]][sources-2.0.x] | [![1.2.x][sources-1.2.x-image]][sources-1.2.x] | [![0.7.x][sources-0.7.x-image]][sources-0.7.x] | [![0.6.x][sources-0.6.x-image]][sources-0.6.x]
100-
| Compatibility | [![Python 3.12][python312-image]][python312-docs] [![Python 3.10][python310-image]][python310-docs] | [![Python 3.10][python310-image]][python310-docs] [![Python 3.8][python38-image]][python38-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 2.7][python27-image]][python27-docs]
101-
| CI | [![devel-Status][devel-build-status-image]][devel-build-status] | [![2.2.x-Status][2.2.x-build-status-image]][2.2.x-build-status] | - | - | - | - | - |
102-
| Documentation | [![devel-Docs][rtd-devel-image]][docs-devel] | [![2.2.x-Docs][rtd-2.2.x-image]][docs-2.2.x] | [![2.1.x-Docs][rtd-2.1.x-image]][docs-2.1.x] | [![2.0.x-Docs][rtd-2.0.x-image]][docs-2.0.x] | [![1.2.x-Docs][rtd-1.2.x-image]][docs-1.2.x] | [![0.7.x-Docs][rtd-0.7.x-image]][docs-0.7.x] | [![0.6.x-Docs][rtd-0.6.x-image]][docs-0.6.x]
97+
| | Devel | 2.3.x | 2.2.x | 2.1.x | 2.0.x | 1.2.x |
98+
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
99+
| Sources | [![devel][sources-devel-image]][sources-devel] | [![2.3.x][sources-2.3.x-image]][sources-2.3.x] | [![2.2.x][sources-2.2.x-image]][sources-2.2.x] | [![2.1.x][sources-2.1.x-image]][sources-2.1.x] | [![2.0.x][sources-2.0.x-image]][sources-2.0.x] | [![1.2.x][sources-1.2.x-image]][sources-1.2.x] |
100+
| Compatibility | [![Python 3.12][python312-image]][python312-docs]<br/>[![Python 3.10][python310-image]][python310-docs] | [![Python 3.12][python312-image]][python312-docs]<br/>[![Python 3.10][python310-image]][python310-docs] | [![Python 3.10][python310-image]][python310-docs]<br/>[![Python 3.8][python38-image]][python38-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] | [![Python 3.6][python36-image]][python36-docs] |
101+
| CI | [![devel-Status][devel-build-status-image]][devel-build-status] | [![2.3.x-Status][2.3.x-build-status-image]][2.3.x-build-status] | [![2.2.x-Status][2.2.x-build-status-image]][2.2.x-build-status] | - | - | - | - | - |
102+
| Documentation | [![devel-Docs][rtd-devel-image]][docs-devel] | [![2.3.x-Docs][rtd-2.3.x-image]][docs-2.3.x] | [![2.2.x-Docs][rtd-2.2.x-image]][docs-2.2.x] | [![2.1.x-Docs][rtd-2.1.x-image]][docs-2.1.x] | [![2.0.x-Docs][rtd-2.0.x-image]][docs-2.0.x] | [![1.2.x-Docs][rtd-1.2.x-image]][docs-1.2.x] |
103103

104104

105105
[license-image]: https://img.shields.io/badge/License-BSD%203--Clause-orange.svg?style=plastic
@@ -113,18 +113,16 @@ Robotics:
113113
[python38-docs]: https://docs.python.org/3.8/
114114
[python36-image]: https://img.shields.io/badge/python-3.6-green.svg?style=plastic
115115
[python36-docs]: https://docs.python.org/3.6/
116-
[python27-image]: https://img.shields.io/badge/python-2.7-green.svg?style=plastic
117-
[python27-docs]: https://docs.python.org/2.7/
118116

119117
[devel-build-status-image]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml/badge.svg
120118
[devel-build-status]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml
119+
[2.3.x-build-status-image]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml/badge.svg??branch=release/2.3.x
120+
[2.3.x-build-status]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml
121121
[2.2.x-build-status-image]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml/badge.svg??branch=release/2.2.x
122122
[2.2.x-build-status]: https://github.com/splintered-reality/py_trees/actions/workflows/pre-merge.yaml
123123

124-
[new-2.2.x]: https://github.com/splintered-reality/py_trees/blob/devel/CHANGELOG.rst#22x-2023-01-23---sequences-and-selectors-with-and-without-memory
125-
126-
127124
[docs-devel]: http://py-trees.readthedocs.io/
125+
[docs-2.3.x]: http://py-trees.readthedocs.io/en/release-2.3.x/
128126
[docs-2.2.x]: http://py-trees.readthedocs.io/en/release-2.2.x/
129127
[docs-2.1.x]: http://py-trees.readthedocs.io/en/release-2.1.x/
130128
[docs-2.0.x]: http://py-trees.readthedocs.io/en/release-2.0.x/
@@ -135,6 +133,7 @@ Robotics:
135133
[docs-0.5.x]: http://docs.ros.org/kinetic/api/py_trees/html/
136134

137135
[docs-devel-image]: http://img.shields.io/badge/docs-devel-brightgreen.svg?style=plastic
136+
[docs-2.3.x-image]: http://img.shields.io/badge/docs-2.3.x-brightgreen.svg?style=plastic
138137
[docs-2.2.x-image]: http://img.shields.io/badge/docs-2.2.x-brightgreen.svg?style=plastic
139138
[docs-2.1.x-image]: http://img.shields.io/badge/docs-2.1.x-brightgreen.svg?style=plastic
140139
[docs-2.0.x-image]: http://img.shields.io/badge/docs-2.0.x-brightgreen.svg?style=plastic
@@ -145,6 +144,7 @@ Robotics:
145144
[docs-0.5.x-image]: http://img.shields.io/badge/docs-0.5.x-brightgreen.svg?style=plastic
146145

147146
[rtd-devel-image]: https://readthedocs.org/projects/py-trees/badge/?version=devel&style=plastic
147+
[rtd-2.3.x-image]: https://readthedocs.org/projects/py-trees/badge/?version=release-2.3.x&style=plastic
148148
[rtd-2.2.x-image]: https://readthedocs.org/projects/py-trees/badge/?version=release-2.2.x&style=plastic
149149
[rtd-2.1.x-image]: https://readthedocs.org/projects/py-trees/badge/?version=release-2.1.x&style=plastic
150150
[rtd-2.0.x-image]: https://readthedocs.org/projects/py-trees/badge/?version=release-2.0.x&style=plastic
@@ -156,6 +156,7 @@ Robotics:
156156
[not-available-docs-image]: http://img.shields.io/badge/docs-n/a-yellow.svg?style=plastic
157157

158158
[sources-devel]: https://github.com/splintered-reality/py_trees/tree/devel
159+
[sources-2.3.x]: https://github.com/splintered-reality/py_trees/tree/release/2.3.x
159160
[sources-2.2.x]: https://github.com/splintered-reality/py_trees/tree/release/2.2.x
160161
[sources-2.1.x]: https://github.com/splintered-reality/py_trees/tree/release/2.1.x
161162
[sources-2.0.x]: https://github.com/splintered-reality/py_trees/tree/release/2.0.x
@@ -166,6 +167,7 @@ Robotics:
166167
[sources-0.5.x]: https://github.com/splintered-reality/py_trees/tree/release/0.5.x
167168

168169
[sources-devel-image]: http://img.shields.io/badge/sources-devel-blue.svg?style=plastic
170+
[sources-2.3.x-image]: http://img.shields.io/badge/sources-2.3.x-blue.svg?style=plastic
169171
[sources-2.2.x-image]: http://img.shields.io/badge/sources-2.2.x-blue.svg?style=plastic
170172
[sources-2.1.x-image]: http://img.shields.io/badge/sources-2.1.x-blue.svg?style=plastic
171173
[sources-2.0.x-image]: http://img.shields.io/badge/sources-2.0.x-blue.svg?style=plastic

0 commit comments

Comments
 (0)