Skip to content

Commit

Permalink
Starting putting instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geky committed Apr 29, 2013
1 parent 122b07d commit b1007e7
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 6 deletions.
21 changes: 15 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,18 @@
*.crf
*.uvopt
*.plg

*.Frank
*.KGilbert

/RASLibTest/*
/Ultrasound Sensor/*
*.__i
*.axf
.DS_Store
*.exe
*.htm
*.iex
*.Jack
*.lnp
*.lst
*.map
*.opt
*.plg
*.tra
*.uvgui.*
*.xls
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
Rasware2013
===========

Description
-----------

A generic robotics controller for the EK-LM4F120XL Stellaris Launchpad.
Authored by the IEEE - Robotics and Automation Society Student Branch at the University of Texas at Austin.


Setup for Windows (WIP)
-----------------

### Getting started with Git ###

1. Create a free GitHub account on [github.com](https://github.com/signup/free)
2. Follow GitHub's great instructions for installing [Git](https://help.github.com/articles/set-up-git) on your computer.

### Forking Rasware ###

1. Once logged into GitHub, go to [ut-ras](https://github.com/ut-ras)'s [Rasware2013](https://github.com/ut-ras/Rasware2013).
2. [Fork](https://help.github.com/articales/fork-a-repo) the project's code through the button on the top right. This will copy the project to your own account.
3. Open Git. Depending on what version is installed, the commands will be slightly different.
4. Clone the project to create a copy on your computer. In GitHub for Windows, simply click on `clone` next to the Rasware2013 project.
5. Right click on Rasware2013 then click on `open in explorer` to open the folder containing the project.

### Installing Putty ###

1. Go to <http://www.chiark.greenend.org.uk/~sgtatham/putty.download.html>.
2. Under "for Windows on Intel x86" click on [putty.exe](http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe) to save putty to your computer.


### Installing the Drivers ###

1. Go to <http://www.ti.com/tool/stellaris_icdi_drivers>.
2. Click `Download` to download the drivers to your computer.
3. Unzip to downloaded file.
4. Plug in a Stellaris Launchpad to your computer with a usb cord.
5. Windows should fail at installing divers.
6. Go to the Device Manager on your computer.
7. For each listing with a yellow warning, right-click and select `Update Driver`.
8. Click `Browse my Computer` and navigate to the unzipped drivers.
9. Once all of the drivers are installed, not the COM port number that appears in the Device manager. It should read `Stellaris Virtual Serial Port (COM29)`.


TODO: figure out how to get Keil easily
TODO: add the sections for running rasdemo and creating team project.
TODO: add additional information section from Rasware2012

Setup for Linux (WIP)
---------------

TODO: Basically get Jimmy to write this

0 comments on commit b1007e7

Please sign in to comment.