Skip to content

Commit

Permalink
Doc and license fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
ImagicTheCat committed Jan 30, 2020
1 parent 1ff441d commit a64d434
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
8 changes: 1 addition & 7 deletions README.adoc
Expand Up @@ -15,13 +15,7 @@ Look at the examples for more understanding of the library.

== Install

Instead of adding the file manually, luarocks can be used:

`luarocks install https://raw.githubusercontent.com/ImagicTheCat/Luaoop/master/rockspecs/luaoop-scm-2.rockspec`

See link:rockspecs[] and https://luarocks.org/modules/imagicthecat-0a6b669a3a/luaoop[luarocks].

NOTE: It is designed to work with LuaJIT (Lua 5.1), but the code should work on latest versions.
See link:rockspecs[] or https://luarocks.org/modules/imagicthecat-0a6b669a3a/luaoop[luarocks].

== API

Expand Down
24 changes: 24 additions & 0 deletions src/Luaoop.lua
@@ -1,6 +1,30 @@
-- https://github.com/ImagicTheCat/Luaoop
-- MIT license (see LICENSE)

--[[
MIT License
Copyright (c) 2017 Imagic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
]]

local Luaoop = {}

local lua5_1 = (string.find(_VERSION, "5.1") ~= nil)
Expand Down

0 comments on commit a64d434

Please sign in to comment.