Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sunjay/turtle

Create Animated Drawings in Rust
https://github.com/sunjay/turtle

draw rust turtle turtle-graphics

Last synced: about 7 hours ago
JSON representation

Create Animated Drawings in Rust

Awesome Lists containing this project

README

        

# turtle

[![Crates.io](https://img.shields.io/crates/v/turtle.svg)](https://crates.io/crates/turtle)
[![Docs.rs](https://docs.rs/turtle/badge.svg)](https://docs.rs/turtle)
[![Crates.io](https://img.shields.io/crates/l/turtle.svg)](https://crates.io/crates/turtle)
[![Crates.io](https://img.shields.io/crates/d/turtle.svg)](https://crates.io/crates/turtle)
[![Build Status](https://dev.azure.com/sunjayv/turtle/_apis/build/status/sunjay.turtle?branchName=master)](https://dev.azure.com/sunjayv/turtle/_build/latest?definitionId=1&branchName=master)
[![Codecov](https://codecov.io/gh/sunjay/turtle/branch/master/graph/badge.svg)](https://codecov.io/gh/sunjay/turtle)
[![Zulip](https://img.shields.io/badge/chat-on%20zulip-success)](https://turtle.zulipchat.com)
[![Tokei Line Count](https://tokei.rs/b1/github/sunjay/turtle?category=code)](https://github.com/sunjay/turtle)

*Tweet your drawings to us on Twitter at [@RustTurtle](https://twitter.com/RustTurtle) and follow us to see 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.

![turtle moving forward](https://github.com/sunjay/turtle/raw/9240f8890d1032a0033ec5c5338a10ffa942dc21/forward.gif)

## 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
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:

![turtle drawing a circle](https://github.com/sunjay/turtle/raw/9240f8890d1032a0033ec5c5338a10ffa942dc21/circle.gif)

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 Zulip] anytime if you are lost.

* **Help with the Rust Language** - [Google], [Stack Overflow], [Rust Users Forum], [Turtle Zulip]
* **Help with Turtle** - [Stack Overflow], [Turtle Zulip], [Google], [Rust Users Forum]
* **Found a bug?** - [Open an issue][issues] (feel free to ask about your bug in the [Turtle Zulip] if you are not sure)

[Google]: http://google.com/
[Stack Overflow]: https://stackoverflow.com/
[Rust Users Forum]: https://users.rust-lang.org/
[Turtle Zulip]: https://turtle.zulipchat.com
[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