Skip to content

Commit

Permalink
Patch release of Astrobee Robot Software v1
Browse files Browse the repository at this point in the history
This commit fixes minor documentation issues found after the initial
release of Astrobee Robot Software v1.
  • Loading branch information
Ted Morse committed Sep 1, 2017
1 parent aca386a commit b8e7238
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
6 changes: 4 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Usage instructions for non-NASA users

Install [Ubuntu 16.04](http://releases.ubuntu.com/16.04) on a host machine, and
make sure that you can checkout and build code:
make sure that you can checkout and build code. If you are using a virtual
machine, please use VMware. Virtualbox doesn't support some of our Gazebo
plugins.

sudo apt-get install build-essential git

Expand All @@ -26,7 +28,7 @@ If you are planning to work on guest science stuff, you will also need the
`astrobee_android` repository. You should checkout the repository in the same
directory you checked out the source code in:
```
export ANDROID_PATH=$SOURCE_PATH"_android"
export ANDROID_PATH="${SOURCE_PATH}_android"
```

Clone the android repository:
Expand Down
10 changes: 7 additions & 3 deletions NASA_INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Usage instructions for NASA users

Install [Ubuntu 16.04](http://releases.ubuntu.com/16.04) on a host machine, and
make sure that you can checkout and build code:
make sure that you can checkout and build code. If you are using a virtual
machine, please use VMware. Virtualbox doesn't support some of our Gazebo
plugins.

sudo apt-get install build-essential git

Expand All @@ -22,7 +24,8 @@ make sure that you can checkout and build code:

### Checkout the project source code

At this point you need to decide where you'd like to put the source code (`SOURCE_PATH`) on your machine:
At this point you need to decide where you'd like to put the source code
(`SOURCE_PATH`) on your machine:

export SOURCE_PATH=$HOME/freeflyer

Expand Down Expand Up @@ -181,7 +184,8 @@ rsync to copy the install directory to `~/armhf` on the two processors.
./scripts/install_to_astrobee.sh $INSTALL_PATH
popd

You are now ready to run the code. This code launches a visualization tool, which starts the flight software as a background process.
You are now ready to run the code. This code launches a visualization tool,
which starts the flight software as a background process.

pushd $SOURCE_PATH
python ./tools/gnc_visualizer/scripts/visualizer --proto4
Expand Down
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,8 @@

## About

<!---
<div style="float: right">
![alt text](../images/astrobee.png "The Astrobee free flying robot")
</div>
--->
![alt text](doc/images/astrobee.png "The Astrobee free flying robot")

<p>
<img src="doc/images/astrobee.png" srcset="../images/astrobee.png 1x" title="Astrobee" align="right" style="display: inline"/>
Astrobee is a free-flying robot that is designed to operate as a payload inside
the International Space Station (ISS). The Astrobee Robot Software consists of
embedded (on-board) software, supporting tools and a simulator. The Astrobee
Expand All @@ -22,11 +17,12 @@ operated in multiple modes: plan-based task execution (command sequencing),
teleoperation, or autonomously through execution of hosted code uploaded by
project partners (guest science). The software simulator enables Astrobee Robot
Software to be evaluated without the need for robot hardware.
</p>

This repository provides flight software and a simulator, both primarily written
in C++. The repository also provides several other utilities, including a tool
for creating maps for localization. A separate repository,
[`astrobee_android`](https://github.com/nasa/astrobee_andrdoid), contains the
[`astrobee_android`](https://github.com/nasa/astrobee_android), contains the
Java API, which uses the ROS messaging system to communicate with flight
software.

Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Astrobee Robot Software v1, release 0.1.0
# Astrobee Robot Software v1, release 0.1.1

## Simulator
- Use the same flight software stack that is run on the platform (but the HW drivers)
Expand Down
2 changes: 1 addition & 1 deletion submodules/android
Submodule android updated from 6a8147 to 6165e8

0 comments on commit b8e7238

Please sign in to comment.