Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation instructions for OSX. #26

Merged
merged 1 commit into from Aug 24, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Expand Up @@ -17,14 +17,20 @@ Svof is licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.
1. Install Lua, LuaFileSystem, LuaRocks, Penlight, and 7zip.
1. Windows: download and install latest [LuaForWindows](https://github.com/rjpcomputing/luaforwindows/releases), which all the Lua components indluded. Install 7zip [from here](http://www.7-zip.org/download.html).
1. Ubuntu: install [Lua](https://apps.ubuntu.com/cat/applications/lua5.1/), [LuaFileSystem](https://apps.ubuntu.com/cat/applications/lua-filesystem/), [LuaRocks](https://apps.ubuntu.com/cat/applications/luarocks/), [Penlight](https://apps.ubuntu.com/cat/applications/lua-penlight/), and [7zip](https://apps.ubuntu.com/cat/applications/p7zip-full/).
1. OSX: haven't got a Mac, someone fill this in.
1. OSX: install [Homebrew](http://brew.sh).
1. Using Brew from your Terminal: `brew install lua` and `brew install p7zip`.
1. Afterwards, make sure to `brew install lua5.1`.
1. Using LuaRocks from your Terminal: `luarocks install luafilesystem` and `luarocks install penlight`
1. Open the command-line and navigate to the Svof folder, and run:

On Ubuntu:
./generate.lua -o <your class>

In Windows:
generate.lua -o <your class>

On OSX:
lua5.1 generate.lua -o <your class>


1. Replace <Svof Git location> with the path to the XML files, and then run this command in Mudlet.
Expand Down