Skip to content

Commit dbafb66

Browse files
authored
Create README.md
1 parent 2b6d2fb commit dbafb66

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ From top to bottom, the released repositories are:
1818

1919
## Installation
2020

21+
### As a Docker Image
22+
23+
Currently the BWI base is supported up to Ubuntu 18.04 and ROS Melodic.
24+
If you are using Ubuntu 20.04 LTS+, you can install and build the
25+
BWI code base as a Docker image using the
26+
[bwi-docker](https://github.com/utexas-bwi/bwi-docker) package.
27+
2128
### From Source
2229

2330
You can install all the BWI components normally built from source on
@@ -120,12 +127,12 @@ After building your workspace or packages, instead of using "source devel/setup.
120127
$ sws
121128
```
122129

123-
Next, update pyYAML:
130+
Install pyYAML:
124131
```
125132
$ pip install -U pyYAML
126133
```
127134

128-
Then you will need to create a password for postgres. To do so, run the script below and follow the promts to enter a password that is not empty:
135+
Then create a password for postgres. Run the script below and follow the promts to enter a password that is not empty:
129136
```
130137
$ ./src/bwi_common/knowledge_representation/scripts/configure_postgresql.sh
131138
```
@@ -135,4 +142,4 @@ Finally, run the command prepare_knowledge_bwi_ahg:
135142
$ prepare_knowledge_bwi_ahg
136143
```
137144

138-
At this point, you should be able to run the BWIbot V4 visit doors demo in Anna Hiss Gym. See the [demo instructions](https://github.com/utexas-bwi/bwi/blob/master/demo_v4.md) in this directory.
145+
At this point, you should run the BWIbot V4 [visit doors demo](https://github.com/utexas-bwi/bwi/blob/master/demo_v4.md) in Anna Hiss Gym to validate the installation.

0 commit comments

Comments
 (0)