Files
rojo/README.md
Lucien Greathouse 3eca4bc439 Rework README
2019-06-21 18:02:09 -07:00

54 lines
2.0 KiB
Markdown

<div align="center">
<a href="https://rojo.space">
<img src="assets/rojo-logo.png" alt="Rojo" height="217" />
</a>
</div>
<div>&nbsp;</div>
<div align="center">
<a href="https://travis-ci.org/LPGhatguy/rojo">
<img src="https://api.travis-ci.org/LPGhatguy/rojo.svg?branch=master" alt="Travis-CI Build Status" />
</a>
<a href="https://crates.io/crates/rojo">
<img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" />
</a>
<a href="https://rojo.space/docs/0.4.x">
<img src="https://img.shields.io/badge/docs-0.4.x-brightgreen.svg" alt="Rojo Documentation" />
</a>
<a href="https://rojo.space/docs/0.5.x">
<img src="https://img.shields.io/badge/docs-0.5.x-brightgreen.svg" alt="Rojo Documentation" />
</a>
</div>
<hr />
**Rojo** is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
With Rojo, it's possible to use industry-leading tools like **Visual Studio Code** and **Git**.
Rojo is designed for **power users** who want to use the **best tools available** for building games, libraries, and plugins.
## Features
Rojo lets you:
* Work on scripts from the filesystem, in your favorite editor
* Version your place, model, or plugin using Git or another VCS
* Sync `rbxmx` and `rbxm` models into your game in real time
* Package and deploy your project to Roblox.com from the command line
Soon, Rojo will be able to:
* Sync instances from Roblox Studio to the filesystem
* Compile MoonScript and other custom things for your project
## [Documentation](https://rojo.space/docs/latest/)
Documentation is hosted from the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of this repository.
## Contributing
Pull requests are welcome!
Rojo supports Rust 1.32 and newer. Any changes to the minimum required compiler version require a _minor_ version bump.
## License
Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.