Skip to content

Commit

Permalink
Documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
LPGhatguy committed Nov 30, 2017
1 parent 7838b2e commit 70e2fdc
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,31 @@

<div>&nbsp;</div>

**EARLY DEVELOPMENT, USE WITH CARE**

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 has a number of desirable features:
It has a number of desirable features *right now*:

* Work from the filesystem, in your favorite editor
* 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
* Similar to [rbxpacker](https://github.com/LPGhatguy/rbxpacker), another one of my projects
* Add strongly-versioned dependencies to your project

## 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)
Make sure you have [Rust 1.21 or newer](https://www.rust-lang.org/) installed.
Expand Down Expand Up @@ -51,7 +64,7 @@ cd my-new-project
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
Coming soon!
Expand Down
8 changes: 4 additions & 4 deletions src/bin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ fn main() {
(about: env!("CARGO_PKG_DESCRIPTION"))

(@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.")
)

(@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 port: --port +takes_value "The port to listen on. Defaults to 8000.")
)

(@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.")
)

Expand Down Expand Up @@ -171,7 +171,7 @@ fn main() {
loop {}
},
("pack", _) => {
eprintln!("Not implemented.");
eprintln!("'rojo pack' is not yet implemented!");
std::process::exit(1);
},
_ => {
Expand Down

0 comments on commit 70e2fdc

Please sign in to comment.