forked from rojo-rbx/rojo
Documentation cleanup
This commit is contained in:
7
CHANGES.md
Normal file
7
CHANGES.md
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Rojo Change Log
|
||||||
|
|
||||||
|
## Current Master
|
||||||
|
* *No changes*
|
||||||
|
|
||||||
|
## 0.1.0
|
||||||
|
* Initial release, functionally very similar to [rbxfs](https://github.com/LPGhatguy/rbxfs)
|
||||||
17
README.md
17
README.md
@@ -10,18 +10,31 @@
|
|||||||
|
|
||||||
<div> </div>
|
<div> </div>
|
||||||
|
|
||||||
|
**EARLY DEVELOPMENT, USE WITH CARE**
|
||||||
|
|
||||||
Rojo is a flexible multi-tool designed for creating robust Roblox projects.
|
Rojo is a flexible multi-tool designed for creating robust Roblox projects.
|
||||||
|
|
||||||
It's designed for power users who want to use the best tools available for building games, libraries, and plugins.
|
It's designed for power users who want to use the best tools available for building games, libraries, and plugins.
|
||||||
|
|
||||||
It has a number of desirable features:
|
It has a number of desirable features *right now*:
|
||||||
|
|
||||||
* Work from the filesystem, in your favorite editor
|
* Work from the filesystem, in your favorite editor
|
||||||
* Version your place, library, or plugin using Git or another VCS
|
* Version your place, library, or plugin using Git or another VCS
|
||||||
|
|
||||||
|
Soon, Rojo will be able to:
|
||||||
|
|
||||||
* Create installation scripts for libraries to be used in standalone places
|
* Create installation scripts for libraries to be used in standalone places
|
||||||
|
* Similar to [rbxpacker](https://github.com/LPGhatguy/rbxpacker), another one of my projects
|
||||||
* Add strongly-versioned dependencies to your project
|
* Add strongly-versioned dependencies to your project
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
Rojo has two components:
|
||||||
|
* The binary, written in Rust
|
||||||
|
* The [Roblox Studio plugin](https://www.roblox.com/library/1211549683/Rojo-v0-0-0), written in Lua
|
||||||
|
|
||||||
|
To install the binary, there are two options:
|
||||||
|
* Cargo, which requires you to have Rust installed
|
||||||
|
* Pre-built binaries from the [the GitHub releases page](https://github.com/LPGhatguy/rojo/releases)
|
||||||
|
|
||||||
### Cargo (Recommended)
|
### Cargo (Recommended)
|
||||||
Make sure you have [Rust 1.21 or newer](https://www.rust-lang.org/) installed.
|
Make sure you have [Rust 1.21 or newer](https://www.rust-lang.org/) installed.
|
||||||
@@ -51,7 +64,7 @@ cd my-new-project
|
|||||||
rojo init
|
rojo init
|
||||||
```
|
```
|
||||||
|
|
||||||
Rojo will ask you questions to get your project configured correctly.
|
Rojo will create an empty project in the directory.
|
||||||
|
|
||||||
### Migrating an Existing Roblox Project
|
### Migrating an Existing Roblox Project
|
||||||
Coming soon!
|
Coming soon!
|
||||||
|
|||||||
@@ -36,18 +36,18 @@ fn main() {
|
|||||||
(about: env!("CARGO_PKG_DESCRIPTION"))
|
(about: env!("CARGO_PKG_DESCRIPTION"))
|
||||||
|
|
||||||
(@subcommand init =>
|
(@subcommand init =>
|
||||||
(about: "Creates a new rojo project")
|
(about: "Creates a new Rojo project")
|
||||||
(@arg PATH: "Path to the place to create the project. Defaults to the current directory.")
|
(@arg PATH: "Path to the place to create the project. Defaults to the current directory.")
|
||||||
)
|
)
|
||||||
|
|
||||||
(@subcommand serve =>
|
(@subcommand serve =>
|
||||||
(about: "Serves the project's files for use with the rojo dev plugin.")
|
(about: "Serves the project's files for use with the Rojo Studio plugin.")
|
||||||
(@arg PROJECT: "Path to the project to serve. Defaults to the current directory.")
|
(@arg PROJECT: "Path to the project to serve. Defaults to the current directory.")
|
||||||
(@arg port: --port +takes_value "The port to listen on. Defaults to 8000.")
|
(@arg port: --port +takes_value "The port to listen on. Defaults to 8000.")
|
||||||
)
|
)
|
||||||
|
|
||||||
(@subcommand pack =>
|
(@subcommand pack =>
|
||||||
(about: "Packs the project into a GUI installer bundle.")
|
(about: "Packs the project into a GUI installer bundle. NOT YET IMPLEMENTED!")
|
||||||
(@arg PROJECT: "Path to the project to pack. Defaults to the current directory.")
|
(@arg PROJECT: "Path to the project to pack. Defaults to the current directory.")
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -171,7 +171,7 @@ fn main() {
|
|||||||
loop {}
|
loop {}
|
||||||
},
|
},
|
||||||
("pack", _) => {
|
("pack", _) => {
|
||||||
eprintln!("Not implemented.");
|
eprintln!("'rojo pack' is not yet implemented!");
|
||||||
std::process::exit(1);
|
std::process::exit(1);
|
||||||
},
|
},
|
||||||
_ => {
|
_ => {
|
||||||
|
|||||||
Reference in New Issue
Block a user