diff --git a/README.md b/README.md index df48be421..2239b5d83 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Join the chat at https://gitter.im/euslisp/jskeus](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/euslisp/jskeus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -This repository containts software devleoped and used by [JSK](http://www.jsk.t.u-tokyo.ac.jp) at The University of Tokyo. +This repository contains software developed and used by [JSK](http://www.jsk.t.u-tokyo.ac.jp) at The University of Tokyo. ## 1. Getting started @@ -61,7 +61,7 @@ $ irteusgl models/irt-all-objects.l "(make-all-objects)" #### 3.1.1 Setup ROS repository -You can skip this procdeure if you already setup ROS system +You can skip this procedure if you have already setup your ROS system ``` sudo sh -c 'echo "deb http://packages.ros.org/ros/ubuntu `lsb_release -cs` main" > /etc/apt/sources.list.d/ros-latest.list' wget http://packages.ros.org/ros.key -O - | sudo apt-key add - @@ -76,7 +76,7 @@ sudo apt-get install ros-indigo-pr2eus ### 3.3 Running demo programs -#### 3.3.1 Visualizinot pr2 robot +#### 3.3.1 Visualization of pr2 robot ``` $ rosrun euscollada pr2.sh ``` @@ -85,7 +85,7 @@ $ rosrun euscollada pr2.sh #### 3.3.2 For real PR2 users -After you set `ROS_MASTER_URI` and `ROS_IP` to your PR2 robot (or simulated PR2), try following command +After you set `ROS_MASTER_URI` and `ROS_IP` to your PR2 robot (or simulated PR2), try the following command: ``` $ roscd pr2eus @@ -106,16 +106,16 @@ $ rossetip ![./pr2-read-state.launch](images/Pr2-read-state.png) -see roseus package in http://github.com/jsk-ros-pkg repository for ROS client library for euslisp +Have a look at roseus package in http://github.com/jsk-ros-pkg repository for ROS client library for euslisp ### 3.4 Support and Trouble Shooting -Use [issue tracker](https://github.com/euslisp/jskeus/issues) for get support +Open an issue on our [issue tracker](https://github.com/euslisp/jskeus/issues) if something doesn't work as expected, or if you want new features implemented. -Use [pull requests](https://github.com/euslisp/jskeus/pulls) to report bugs or patches. +Use the [pull requests](https://github.com/euslisp/jskeus/pulls) system to send us solutions for the issues so we can implement them in this repository. -### 3.5 Online Documents (Currently only Japanese is avilable) +### 3.5 Online Documents (Currently only Japanese is available) See online [manual](http://euslisp.github.io/jskeus/) @@ -125,31 +125,31 @@ PDF files are also available from [here](https://github.com/euslisp/jskeus/raw/m #### 3.6.1 Installing dependent libraries -for Ubuntu users +For Ubuntu users: ``` $ sudo apt-get install git make gcc g++ libjpeg-dev libxext-dev libx11-dev libgl1-mesa-dev libglu1-mesa-dev libpq-dev libpng12-dev xfonts-100dpi xfonts-75dpi gsfonts-x11 texlive-fonts-extra xfonts-100dpi-transcoded xfonts-75dpi-transcoded msttcorefonts ``` -for Mac OSX users using Homebrew +For Mac OSX users using Homebrew: ``` $ brew install jpeg libpng mesalib-glw wget ``` '''NOTE:''' -EusLisp needs X11 Library, but Mac OSX mountain lion no longer support it. So you need to install substitution [XQuartz](http://xquartz.macosforge.org/landing/). +EusLisp needs X11 Library, but Mac OSX mountain lion no longer supports it. Given this case, you'll need to install [XQuartz](http://xquartz.macosforge.org/landing/). -Also for Mac OSX lion (or older) users it's better to install the latest XQuartz for the safety. +Also for Mac OSX lion (or older) users it's better to install the latest XQuartz for safety and compatibility reasons. (If XQuartz is older than 2.7.3, the installation of EusLisp will fail. You should install the latest XQuartz.) -for Raspberry Pi users using debian(Raspbian "wheezy") +For Raspberry Pi users using debian(Raspbian "wheezy"): ``` $ sudo apt-get install git gcc g++ libjpeg62-dev libxext-dev libx11-dev libgl1-mesa-dev libglu1-mesa-dev libpq-dev libpng12-dev xfonts-100dpi xfonts-75dpi ## additional install for using OpenGL on raspberry pi $ sudo apt-get install libgl1-mesa-dri xserver-xorg-video-vesa xutils ``` -for Cygwin(now working with 32bit only) +For Cygwin(only works with 32bit systems) ``` Packages listed below should be intalled using setup.exe. @@ -173,7 +173,7 @@ $ echo "source ~/bashrc.eus" >> ~/.bashrc #### 3.6.3 Install ROS and jsk-ros-pkg repository -See http://wiki.ros.org/indigo/Installation/Source for more detail +See http://wiki.ros.org/indigo/Installation/Source for more details ``` $ sudo apt-get install python-rosdep python-rosinstall-generator python-wstool python-rosinstall build-essential @@ -189,4 +189,4 @@ $ source devel/setup.bash ### 3.7 Acknowledgment -The software in this repository is based on [EusLisp language](http://euslisp.sourceforge.net). +Software in this repository is based on the [EusLisp language](http://euslisp.sourceforge.net).