rojo-rbx/rojo
1
0
Fork 1
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-04-20 12:45:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Lucien Greathouse
2019-06-24 11:24:50 -07:00
parent 522f26cf4e
commit 4dab6e5008
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -7,17 +7,17 @@
<div>&nbsp;</div> <div>&nbsp;</div>
<div align="center"> <div align="center">
<a href="https://travis-ci.org/LPGhatguy/rojo"> <a href="https://travis-ci.org/rojo-rbx/rojo">
<img src="https://api.travis-ci.org/LPGhatguy/rojo.svg?branch=master" alt="Travis-CI Build Status" /> <img src="https://api.travis-ci.org/rojo-rbx/rojo.svg?branch=master" alt="Travis-CI Build Status" />
</a> </a>
<a href="https://crates.io/crates/rojo"> <a href="https://crates.io/crates/rojo">
<img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" /> <img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" />
</a> </a>
<a href="https://rojo.space/docs/0.4.x"> <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" /> <img src="https://img.shields.io/badge/docs-0.4.x-brightgreen.svg" alt="Rojo 0.4.x Documentation" />
</a> </a>
<a href="https://rojo.space/docs/0.5.x"> <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" /> <img src="https://img.shields.io/badge/docs-0.5.x-brightgreen.svg" alt="Rojo 0.5.x Documentation" />
</a> </a>
</div> </div>
@@ -27,28 +27,30 @@
With Rojo, it's possible to use industry-leading tools like **Visual Studio Code** and **Git**. 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. Rojo is designed for power users who want to use the best tools available for building games, libraries, and plugins.
## Features ## Features
Rojo lets you: Rojo enables:
* Work on scripts from the filesystem, in your favorite editor * Working on scripts and models from the filesystem, in your favorite editor
* Version your place, model, or plugin using Git or another VCS * Versioning your game, library, or plugin using Git or another VCS
* Sync `rbxmx` and `rbxm` models into your game in real time * Streaming `rbxmx` and `rbxm` models into your game in real time
* Package and deploy your project to Roblox.com from the command line * Packaging and deploying your project to Roblox.com from the command line
Soon, Rojo will be able to: Soon, Rojo will be able to:
* Automatically convert your existing game to work with Rojo
* Sync instances from Roblox Studio to the filesystem * Sync instances from Roblox Studio to the filesystem
* Compile MoonScript and other custom things for your project * Automatically manage your assets on Roblox.com, like images and sounds
* Import custom instances like MoonScript code
## [Documentation](https://rojo.space/docs/latest/) ## [Documentation](https://rojo.space/docs/latest)
Documentation is hosted from the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of this repository. If you find any mistakes, feel free to make changes in the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of this repository and submit a pull request!
## Contributing ## Contributing
Pull requests are welcome! Pull requests are welcome!
Rojo supports Rust 1.32 and newer. Any changes to the minimum required compiler version require a _minor_ version bump. Rojo supports Rust 1.32 and newer.
## License ## License
Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details. Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.