Muon is a C++ framework designed to be used as a layer between the Standard Library and some missing feature I'm using in other projects.
You will need the following:
- A C++11 compiler
- Premake5 (See bottom of this README)
- Optionally, an IDE
- Optionally, Git
The premake build system is used to generate IDE solutions or makefiles. It's been choosed over CMake because it is very small (and can be fearlessly embedded in the repository), it uses a well-known language (Lua) rather than a custom cryptic one, which makes writing build scripts very easy.
- Get the engine from its Git repository, or download a zip file from Github
- Run premake5 for the platform / target you want to build
- You should now see your project / make file at the root of the repository
Example with Visual Studio 2013:
- Open a command prompt in the repository
- Run
premake5.exe vs2013 - A set of Visual Studio file ( Muon.sln, Muon.vcproj, ...) are now located in the repository root folder
- Open the Muon.sln file
- Build the solution
- Run the
premake5.exe installcommand. (Depending on where you want to install, you may require administrator rights)
If you've pulled a new version of the project, it is recommanded to regenerate the solution using premake.
- The
premake5 installcommand will install header and libraries (.dll, .lib, .so, ...) files- On Windows, they're installed under the C:\Premake folder
- On Unix, they're installed under the /usr/local/ folder (and may require the use of
sudo)
This project is licenced under the Creative Commons - Attribution & Share Alike licence
You can get the source from the premake-dev repo and build it yourself, or directly download the executable at: http://premake.github.io/download.html
The repository also have both Unix and Windows premake executable, resepctively premake5 and premake5.exe.
(You may require to chmod +x premake5 on Unix)