GitHub - LuaDist/luametrics

This repository has been archived by the owner on Nov 20, 2020. It is now read-only.

Name		Name	Last commit message	Last commit date
Latest commit History 41 Commits
3rdparty		3rdparty
cmake		cmake
share		share
src/metrics		src/metrics
.travis.yml		.travis.yml
CMakeLists.txt		CMakeLists.txt
COPYRIGHT		COPYRIGHT
README		README
dist.info		dist.info

Repository files navigation

* About LuaMetrics
---------------
- TODO !!!

* Availability
------------
LuaMetrics is freely available for both academic and commercial purposes under
MIT license. See COPYRIGHT for details.

* Dependecies
-----------------------------------------
LuaMetrics requires following modules to be installed:
	lua >= 5.1	(not tested with 5.2)
	leg == 0.1.3	(leg version 0.1.3 is provided by LuaDist and supports lpeg >= 0.10)
	lpeg >= 0.10
	luacomments >= 0.2

* Installation
------------
Simplest way to install LuaMetrics is to use the LuaDist (www.luadist.org) deployment
tool by invoking:

	> ./luadist _luametrics install luametrics

which will install LuaMetrics and all it's dependencies into the _luametrics folder.
LuaMetrics can be also installed using CMake (www.cmake.org). For manual installation
copy the metrics folder from src into your LUA_PATH folder.

* Running
-------
LuaMetrics is currently only a Lua module and does not provide any applications.
However the LuaDocer [1] documentation tool uses LuaMetrics heavily - please see
documentations generated by LuaDocer to see what source code metrics can
LuaMetrics  produce.

* Compatibility
-------------
LuaMetrics was tested only on Linux platform, but should work on all main platforms.

* Authors
-------
LuaMetrics is developed and maintained by:
	Ivan Šimko  (main developer)
	Peter Kapec (project supervisor)

* References
-------
[1] https://github.com/LuaDist/luadocer