Skip to content

Commit

Permalink
add documentation for getting the solid works files
Browse files Browse the repository at this point in the history
  • Loading branch information
matthieu-lapeyre committed May 17, 2016
1 parent 64a15d4 commit 7aea493
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 21 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,31 @@ Poppy Humanoid

Poppy Humanoid is an open-source and 3D printed humanoid robot. Optimized for research and education purposes, its modularity allows for a wide range of applications and experimentations.


![Trunk Assembled](doc/img/poppy-humanoid-github.jpg)

### Open Source

All the technological development work made in the Poppy project is freely available under open source licenses. Only the name usage *"Poppy"* is restricted and protected as an international trademark, please contact us if you want to use it or have more information.


| License | Hardware | Software |
| ------------- | :-------------: | :-------------: |
| Title | [Creatives Commons BY-SA](http://creativecommons.org/licenses/by-sa/4.0/) |[GPL v3](http://www.gnu.org/licenses/gpl.html) |
| Logo | [![Creative Commons BY-SA](https://i.creativecommons.org/l/by-sa/4.0/88x31.png) ](http://creativecommons.org/licenses/by-sa/4.0/) |[![GPL V3](https://www.gnu.org/graphics/gplv3-88x31.png)](http://www.gnu.org/licenses/gpl.html) |


**Please keep references to the [Poppy project (www.poppy-project.org)](https://www.poppy-project.org/) and [authors](doc/authors.md) when you use or fork this work.**

### Looking for the Solidworks files ?

We are using a GitHub feature called GIT LFS. It is great for versionning solidworks files but it stills lack basic features. If you download directly solidworks files from this web page, you will get an empty file...

You have two option:

1. Download the last official Solidworks version in the [release](releases/). You will also find STL, STEP and parasolid files.
- Clone locally this repository following [this guide](doc/cloning.md). This solution is only for people desiring to contribute or develop news hardware features for Poppy.

## Build your own Poppy Humanoid

Building a complete Poppy Humanoid costs $8000-9000 with about 60% for buying the 25 Robotis Dynamixel actuators required. The full BOM is available here >> [Bill Of Material](hardware/doc/BOM.md).
Expand All @@ -24,6 +47,8 @@ The assembly process is fully documented with video tutorials.
#### Install a Poppy board
Poppy Humanoid is made to work with an Odroid U3 or an Odroid XU4. We provide our own [system image](https://github.com/poppy-project/poppy-humanoid/releases) (based on Ubuntu 14.04) that can be directly copied to the SD-card or MMC. You can refer to the [documentation](http://docs.poppy-project.org/en/installation/burn-an-image-file.html) for more details. Note that if you buy it as a kit from one of the reseller you will also get a pre-installed SD-card.

### Install the software tools locally
If you want to install the software tools locally and not use the embedded board to control the Robot or if you are working with the simulator, you will have to install Python. We strongly recommand using a pre-packaged distribution as [Anaconda](http://continuum.io/downloads) and install the [poppy-humanoid](https://github.com/poppy-project/poppy-humanoid/tree/master/software) package (the easiest way is via pip).

You can also use our setup script directly on a Odroid based on Ubuntu or Debian. **Be aware tough that it takes some time and some good knowledge of Linux** This script is used to setup the Odroid to match our needs (custom Python, setup the web interface, a Poppy user...).
```
Expand All @@ -34,7 +59,7 @@ sudo bash poppy_setup.sh poppy-humanoid


#### Install on your personnal computer
If you want to install the software locally and not use the embedded board to control the robot or if you are working with the simulator, you will have to install Python. We strongly recommand using a pre-packaged distribution as [Anaconda](http://continuum.io/downloads) and install the [poppy-humanoid](https://github.com/poppy-project/poppy-humanoid/tree/master/software) package (the easiest way is with `pip install poppy-humanoid`).
If you want to install the software locally and not use the embedded board to control the robot or if you are working with the simulator, you will have to install Python. We strongly recommand using a pre-packaged distribution as [Anaconda](http://continuum.io/downloads) and install the [poppy-humanoid](https://github.com/poppy-project/poppy-humanoid/tree/master/software) package (the easiest way is with `pip install poppy-humanoid`).

**For more informations, refer to the [poppy documentation](http://docs.poppy-project.org/en/installation/index.html)**.

Expand All @@ -49,12 +74,12 @@ You can in particular check for the [Poppy Humanoid category](https://forum.popp

If you are interrested by contribuing to the Poppy project, you can **take a look at [open issues](https://github.com/poppy-project/poppy-humanoid/issues) and [call for contributions](https://forum.poppy-project.org/tags/call-for-contributions)**.

Morevover, the Poppy project involves a very large scope of disciplines:
- Engineering fields such as computer science, mechanics, electronics, machine learning...
Morevover, the Poppy project involves a very large scope of disciplines:
- Engineering fields such as computer science, mechanics, electronics, machine learning...
- Humanities such as cognitive science, psychology...
- Life science such as biology, biomechanics,...
- Community management, scientific mediation, communication...
- Design such as web design, object design, UX,...
- Design such as web design, object design, UX,...
- Art with the need of animator to create [the illusion of life](http://en.wikipedia.org/wiki/Disney_Animation:_The_Illusion_of_Life) and emotions.

So there are many ways to contribute to this project and you are very welcome to do it.
Expand Down
42 changes: 42 additions & 0 deletions doc/en/cloning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Cloning this repository

Git and Github are designed for versioning code, using it as a versioning platform for hardware files is a bit out of the scope this tools are made for.

Therefore, we use quite advanced git features such as Submodules and Git LFS.

## Installation

To clone this repository, you need both Git and Git LFS.

1. [Installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Installing GIT LFS](https://help.github.com/articles/installing-git-large-file-storage/#platform-windows)


### [Optional] Install Source Tree

Source Tree is a software providing a nice and easy to use interface for Git. If you are not familiar with Git, it helps a lot understanding what the hell happens.

You can download it [here](https://www.sourcetreeapp.com/)


## Clone the repository

Once you have installed every soft needed, you can "clone" the repository.

### Using Source Tree

Configure your app, then click on the **new repository** button and specify the url of this repository `https://github.com/poppy-project/poppy-humanoid.git`

![](../img/clone-humanoid-sourcetree.PNG)

If you have forked this project, replace the url by your `https://github.com/YOUR-USERNAME/poppy-humanoid.git`

### Using the Command line

Open your terminal (or Git Bash on Windows) and tape ` git clone --recursive git://github.com/poppy-project/poppy-humanoid.git`

![](../img/clone-humanoid-bash.PNG)

This will clone the entire repository including all submodules and download all files.

Again, if you have forked the repository, change the url accordingly.
17 changes: 0 additions & 17 deletions doc/en/contribution.md

This file was deleted.

Binary file added doc/img/clone-humanoid-bash.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/img/clone-humanoid-sourcetree.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7aea493

Please sign in to comment.