# turtle
[](https://crates.io/crates/turtle)
[](https://docs.rs/turtle)
[](https://crates.io/crates/turtle)
[](https://crates.io/crates/turtle)
[](https://travis-ci.org/sunjay/turtle)
[](https://ci.appveyor.com/project/sunjay/turtle/branch/master)
[](https://gitter.im/rust-turtle/discuss)
*Tweet your drawings to us on Twitter at [@RustTurtle](https://twitter.com/RustTurtle) and follow us to what is being created!*
Create animated drawings with the [Rust programming language][rust]. This
crate is a tool for teaching programming by drawing pictures. Learning this
way is fun and interesting for people of all ages!
**The idea:** You control a turtle with a pen tied to its tail. As it moves
across the screen, it draws the path that it follows. You can use this to draw
any picture you want just by moving the turtle across the screen.
## Documentation
* [Website](http://turtle.rs)
* [API Documentation](https://docs.rs/turtle)
## Example
As a simple example, you can draw a circle with only the following code:
```rust
extern crate turtle;
use turtle::Turtle;
fn main() {
let mut turtle = Turtle::new();
for _ in 0..360 {
// Move forward three steps
turtle.forward(3.0);
// Rotate to the right (clockwise) by 1 degree
turtle.right(1.0);
}
}
```
This will produce the following:
See the [`examples/`](https://github.com/sunjay/turtle/raw/master/examples)
directory for more examples of how to use this crate.
## Need help?
The following are some resources you can use to find help when you run into a
problem. The links are listed in the order you should try each one, but feel
free to come to the [Turtle Gitter] anytime if you are lost.
* **Help with the Rust Language** - [Google], [Stack Overflow], [Rust Users Forum], [Turtle Gitter]
* **Help with Turtle** - [Stack Overflow], [Turtle Gitter], [Google], [Rust Users Forum]
* **Found a bug?** - [Open an issue][issues] (feel free to ask about your bug in the [Turtle Gitter] if you are not sure)
[Google]: http://google.com/
[Stack Overflow]: https://stackoverflow.com/
[Rust Users Forum]: https://users.rust-lang.org/
[Turtle Gitter]: https://gitter.im/rust-turtle/discuss
[issues]: https://github.com/sunjay/turtle/issues
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to
this project including how to build and test the project, submit new examples,
report bugs, and more.
## Inspiration & Goals
This crate is inspired by the [Logo educational programming language][logo-lang].
Many languages contain implementations of Logo's "turtle graphics". For example,
the [Python programming language][python] comes with a
[built-in turtle module][turtle-py]. This crate is largely inspired by the
Python implementation, but uses Rust conventions and best practices to provide
the best possible platform for learning Rust.
The goal of this crate is to be as easy to approach as possible and also provide
the opportunity to explore Rust's most advanced features. We welcome
contributions from anyone and everyone, including those that are new to the Rust
programming language.
[rust]: https://www.rust-lang.org/
[logo-lang]: https://en.wikipedia.org/wiki/Logo_(programming_language)
[python]: https://www.python.org/
[turtle-py]: https://docs.python.org/2/library/turtle.html