Skip to content

Commit

Permalink
:recylcle: Updates code formatting and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Sep 29, 2020
1 parent 98cf8af commit cd5ce34
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 17 additions & 17 deletions README.md
@@ -1,6 +1,6 @@
# ROS Conda wrapper

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3bac6de9531d40e699010223fa5a0ddf)](https://app.codacy.com/app/rickstaa/ros_conda_wrapper?utm_source=github.com&utm_medium=referral&utm_content=rickstaa/ros_conda_wrapper&utm_campaign=Badge_Grade_Dashboard)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6e8ab010990d4363bfe079944bfe16e4)](https://www.codacy.com/gh/rickstaa/.ros_conda_wrapper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=rickstaa/.ros_conda_wrapper&utm_campaign=Badge_Grade)
[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green)](https://github.com/rickstaa/ros_conda_wrapper/pulse)
[![Contributions](https://img.shields.io/badge/contributions-welcome-orange.svg)](contributing.md)
[![Python 3](https://img.shields.io/badge/python%203-3.7%20%7C%203.6%20%7C%203.5-yellow.svg)](https://www.python.org/)
Expand All @@ -14,16 +14,16 @@ This wrapper solves some known problems you might experience while trying to use

## How to setup

1. Clone the repository to your user home directory and cd into the `.ros_conda_wrapper` folder.
1. Clone the repository to your user home directory and cd into the `.ros_conda_wrapper` folder.

```bash
git clone https://github.com/rickstaa/.ros_conda_wrapper.git
cd .ros_conda_wrapper
```
```bash
git clone https://github.com/rickstaa/.ros_conda_wrapper.git
cd .ros_conda_wrapper
```

### Automatic installation

2. Run the `install.sh` script to install the ROS Conda wrapper.
2. Run the `install.sh` script to install the ROS Conda wrapper.

### Manual installation

Expand All @@ -40,13 +40,13 @@ To uninstall the ROS Conda wrapper run the `uninstall.sh` script before removing
All of the original `conda` commands work as expected. Additionally, a `--ros-wrapper`
command has been added. This command takes the following options:

- `activate`: Activates the ROS Conda wrapper.
- `deactivate`: Deactivates the ROS Conda wrapper.
- `init <CONDA_ENVIRONMENT>`: Initializes a given &lt;CONDA_ENVIRONMENT> to work with ROS.
- `deinit <CONDA_ENVIRONMENT>`: Deinitializes a given ROS &lt;CONDA_ENVIRONMENT> to work.
- `-h, --help`: Displays usage information.
- `-v, --version`: ROS Conda wrapper version.
- `-s, --show-settings`: Shows the current settings.
- `activate`: Activates the ROS Conda wrapper.
- `deactivate`: Deactivates the ROS Conda wrapper.
- `init <CONDA_ENVIRONMENT>`: Initializes a given &lt;CONDA_ENVIRONMENT> to work with ROS.
- `deinit <CONDA_ENVIRONMENT>`: Deinitializes a given ROS &lt;CONDA_ENVIRONMENT> to work.
- `-h, --help`: Displays usage information.
- `-v, --version`: ROS Conda wrapper version.
- `-s, --show-settings`: Shows the current settings.

:information_source: The `conda --ros-wrapper init` command does not create the environment itself it only performs some actions such that ROS will work inside a python 3 Conda environment.

Expand Down Expand Up @@ -76,9 +76,9 @@ conda --ros-wrapper deactivate

The ROS Conda wrapper adds the following environment variables:

- `ROS_CONDA_WRAPPER`: Specifies whether the ROS Conda wrapper is installed.
- `ROS_CONDA_WRAPPER_ACTIVE`: Specifies whether the ROS Conda wrapper is activated.
- `ROS_CONDA_WRAPPER_ERROR`: Anaconda is not initiated or installed.
- `ROS_CONDA_WRAPPER`: Specifies whether the ROS Conda wrapper is installed.
- `ROS_CONDA_WRAPPER_ACTIVE`: Specifies whether the ROS Conda wrapper is activated.
- `ROS_CONDA_WRAPPER_ERROR`: Anaconda is not initiated or installed.

## How it works

Expand Down
2 changes: 1 addition & 1 deletion install.sh
Expand Up @@ -22,7 +22,7 @@ if [ -L "${WRAPPER_LINK}" ]; then # If symbolic link exists
echo "ROS Conda wrapper file added to your home directory."
ln -fs "$(pwd)/${WRAPPER_NAME}" "$(echo "$HOME")/.${WRAPPER_NAME}"
fi
elif [ -e ${WRAPPER_LINK} ]; then # If exists but is not a symbolic link
elif [ -e "${WRAPPER_LINK}" ]; then # If exists but is not a symbolic link

# Add Ros Conda wrapper file to the user home directory
echo "ROS Conda wrapper file added to your home directory."
Expand Down

0 comments on commit cd5ce34

Please sign in to comment.