Rework README

This commit is contained in:
Lucien Greathouse
2019-06-21 18:02:09 -07:00
parent b374f67b52
commit 3eca4bc439

View File

@@ -1,5 +1,7 @@
<div align="center">
<img src="assets/rojo-logo.png" alt="Rojo" height="217" />
<a href="https://rojo.space">
<img src="assets/rojo-logo.png" alt="Rojo" height="217" />
</a>
</div>
<div>&nbsp;</div>
@@ -11,10 +13,10 @@
<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://lpghatguy.github.io/rojo/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" />
</a>
<a href="https://lpghatguy.github.io/rojo/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" />
</a>
</div>
@@ -40,24 +42,8 @@ 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://lpghatguy.github.io/rojo)
You can also view the documentation by browsing the [docs](https://github.com/LPGhatguy/rojo/tree/master/docs) folder of the repository, but because it uses a number of Markdown extensions, it may not be very readable.
## Inspiration and Alternatives
There are lots of other tools that sync scripts into Roblox or provide other tools for working with Roblox places.
Here are a few, if you're looking for alternatives or supplements to Rojo:
* [rbxmk by Anaminus](https://github.com/anaminus/rbxmk)
* [Rofresh by Osyris](https://github.com/osyrisrblx/rofresh)
* [RbxRefresh by Osyris](https://github.com/osyrisrblx/RbxRefresh)
* [Studio Bridge by Vocksel](https://github.com/vocksel/studio-bridge)
* [Elixir by Vocksel](https://github.com/vocksel/elixir)
* [RbxSync by evaera](https://github.com/evaera/RbxSync)
* [CodeSync by MemoryPenguin](https://github.com/MemoryPenguin/CodeSync)
* [rbx-exteditor by MemoryPenguin](https://github.com/MemoryPenguin/rbx-exteditor)
If you use a plugin that _isn't_ Rojo for syncing code, open an issue and let me know why! I'd like Rojo to be the end-all tool so that people stop reinventing solutions to this problem.
## [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!