updated README

This commit is contained in:
Enrique García 2010-12-07 23:57:06 +01:00
parent 17f52a4731
commit cb94d95fd7

View File

@ -43,22 +43,19 @@ Features left out:
h1. Installation using git (recommended) h1. Installation using git (recommended)
The easiest way is creating a clone using git: The easiest way is creating a clone using git:
<pre>
git clone git://github.com/kikito/middleclass.git <pre>git clone git://github.com/kikito/middleclass.git</pre>
</pre>
This will create a folder called @middleclass@. You can require it using: This will create a folder called @middleclass@. You can require it using:
<pre>
require 'middleclass.init' <pre>require 'middleclass.init'</pre>
</pre>
If you have @?/init.lua@ included in your @package.path@ variable, you can remove the @.init@ part. If you have @?/init.lua@ included in your @package.path@ variable, you can remove the @.init@ part.
If you ever want to update middleclass, you can use the following commands: If you ever want to update middleclass, you can use the following commands:
<pre>
cd your/path/to/middleclass <pre>cd your/path/to/middleclass
git pull origin master git pull origin master</pre>
</pre>
Git will automatically update middleclass for you. Git will automatically update middleclass for you.
@ -72,9 +69,7 @@ As an alternative, you can directly download "middleclass.lua":https://github.co
In that case, you will have to require it doing something like this (will vary if you put middleclass.lua inside a folder): In that case, you will have to require it doing something like this (will vary if you put middleclass.lua inside a folder):
<pre> <pre>require 'middleclass'</pre>
require 'middleclass'
</pre>
(This assumes you have @?.lua@ in your @package.path@, which is the default) (This assumes you have @?.lua@ in your @package.path@, which is the default)