---
# System prepended metadata

title: Project documentation template
tags: [Templates, Documentation]

---

---
title: 'Project documentation template'
disqus: hackmd
---

EE287
===
![downloads](https://img.shields.io/github/downloads/atom/atom/total.svg)
![build](https://img.shields.io/appveyor/ci/:user/:repo.svg)
![chat](https://img.shields.io/discord/:serverId.svg)

## Table of Contents

[TOC]

## week 1 

lab 0

1. Install curl 
Ubuntu install curl command
First update the system and get latest stable curl version for Ubuntu:
$ sudo apt update
$ sudo apt upgrade

Type the following apt command or apt-get command:
$ sudo apt install curl

2. Set up your keys
   curl -s https://raw.githubusercontent.com/ros/rosdistro/master/ros.asc
   然后输入：sudo apt-key add -
3. 密码
sudo apt-get update
4. bashrc permission denied
 To edit the file run nano .bashrc
4. install ros
   重新更新，不然安装不了 sudo apt-get update
http://wiki.ros.org/kinetic/Installation/Ubuntu

tutorial for ros beginner
---

https://ucr-robotics.readthedocs.io/en/latest/intro_ros.html
http://wiki.ros.org/ROS/Tutorials

week 1
---
TurtleBot 的 目的是给入门级的机器人爱好者或或从事移动机器人编程开发者提供一个基础开发平台，让他们直接使用TurtleBot自带的软硬件，能专注于应用程序的开 发。避免了设计草图，购买、加工材料、设计电路、编写程序、组装等一系列工作。借助该机器人平台，可以节省很多前期工作，只要根据平台的软硬件接口，就能 开发出所需的功能。

catkin_ws
初始化工作空间 NOTE: catkin_ws是工作空间的名字，当然你可以随意指定；src是存放功能包的地方，该名称不能自定义，必须是src； -p 意思是如果父目录不存在就同时创建父目录。

setup.bash
这句话的目的就是在开新的terminal的时候，运行这个setup.bash，而这个setup.bash的作用是让一些ROS* 开头的命令可以使用。 使用source命令运行这些脚本文件，则工作空间的环境变量设置可以生效（如可以找到该工作空间内的项目）。


查看是否安装

因为linux安装软件的方式比较多，所以没有一个通用的办法能查到某些软件是否安装了。总结起来就是这样几类：

1、rpm包安装的，可以用rpm -qa看到，如果要查找某软件包是否安装，用 rpm -qa | grep “软件或者包的名字”。

[root@hexuweb102 ~] rpm -qa | grep ruby
2、以deb包安装的，可以用dpkg -l能看到。如果是查找指定软件包，用dpkg -l | grep “软件或者包的名字”；

[root@hexuweb102~]dpkg-l|grepruby
3、yum方法安装的，可以用yum list installed查找，如果是查找指定包，命令后加 | grep “软件名或者包名”；

[root@hexuweb102 ~] yum list installed | grep ruby

4、如果是以源码包自己编译安装的，例如.tar.gz或者tar.bz2形式的，这个只能看可执行文件是否存在了，

上面两种方法都看不到这种源码形式安装的包。如果是以root用户安装的，可执行程序通常都在/sbin:/usr/bin目录下。

说明：其中rpm yum 是Redhat系linux的软件包管理命令，dpkg是debian系列的软件包管理命令


————————————————
版权声明：本文为CSDN博主「MC-闰土」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/qq_22075041/article/details/78855849

gedit 文本编辑器
是一个GNOME桌面环境下兼容UTF-8的文本编辑器。 它简单易用，有良好的语法高亮，对中文支持很好，支持包括GB2312、GBK在内的多种字符编码。 gedit是一款自由软件。

Gazebo
是一款功能强大的三维物理仿真平台，具备强大的物理引擎、高质量的图形渲染、方便的编程与图形接口，最重要的是其开源免费的特性。 gazebo中的机器人模型与rviz使用的模型相同，但是需要在模型中加入机器人和周围环境的物理属性，例如质量、摩擦系数、弹性系数等。

Exit gedit file edit
To close a file in gedit, select Close. Alternately, you can click the small "X" that appears on the right-side of the file's tab, or press Ctrl + W .

退出当前错误
使用键盘control^ + \ 即可。


User flows
---
```sequence
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
Note left of Alice: Alice responds
Alice->Bob: Where have you been?
```

> Read more about sequence-diagrams here: http://bramp.github.io/js-sequence-diagrams/

Project Timeline
---
```mermaid
gantt
    title A Gantt Diagram

    section Section
    A task           :a1, 2014-01-01, 30d
    Another task     :after a1  , 20d
    section Another
    Task in sec      :2014-01-12  , 12d
    anther task      : 24d
```

> Read more about mermaid here: http://mermaid-js.github.io/mermaid/

## 问题

:::info
**安装了pip 3，而不是pip
:::

###### tags: `Templates` `Documentation`
