mirror of
https://github.com/CPunch/Cosmo.git
synced 2024-11-05 08:10:05 +00:00
update README.md
This commit is contained in:
parent
788911130d
commit
07ba4c731e
19
README.md
19
README.md
@ -1,6 +1,20 @@
|
||||
# Cosmo
|
||||
[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/CPunch/Cosmo?svg=true)](https://ci.appveyor.com/project/CPunch/Cosmo)
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
Usage: ./bin/cosmo [-clsr] [args]
|
||||
|
||||
available options are:
|
||||
-c <in> <out> compile <in> and dump to <out>
|
||||
-l <in> load dump from <in>
|
||||
-s <in...> compile and run <in...> script(s)
|
||||
-r start the repl
|
||||
```
|
||||
|
||||
## What is a 'cosmo'?
|
||||
|
||||
Cosmo is a portable scripting language loosely based off of Lua. Cosmo easily allows the user to extend the language through the use of Proto objects, which describe the behavior of Objects. For example the following is a simple Vector Proto which describes behavior for a Vector-like object.
|
||||
|
||||
```lua
|
||||
@ -39,7 +53,4 @@ end
|
||||
2 : 1
|
||||
1 : 2
|
||||
0 : 3
|
||||
```
|
||||
|
||||
# C API
|
||||
The Cosmo C API is currently undocumented, however as soon as development has reached a stable state documentation on full language features and the C API will start.
|
||||
```
|
Loading…
Reference in New Issue
Block a user