Metal

Experimental prototype-based object model runtime in C99 (with some GNU extensions). Inspired by Objective-C, Lua, and [Piumarta-and-Warth-2007].

Getting Started

• Install GCC or Clang
• Install Ruby
• Install Rake
• Install Git
• Clone repo: git clone [email protected]:konstantinbe/metal.git
• Build & some: rake some

For debugging (optional):

• Install GDB or LLDB
• Build & debug: rake debug

For profiling (optional):

• Install Gcov
• Build & profile: rake profile

For memory analysis (optional):

• Install Valgrind
• Build & run memory analysis: rake valgrind

For building website (optional):

• Install Redcarpet
• Build website: rake website
• Open build/website/index.html in a browser

Conventions

• 4 spaces, no tabs
• Brace style: opening brace on same line, closing brace on separate line
• Use dashed notation for methods: replace-at*with-many*, is-mutable?
• Use UPPERCASE notation for global constants: GREATER_THAN
• Use CamelCase for everything else in code (types, functions, variables, ...): IndexOf, instanceVariableName
• Use dashed notation for directories and files: array.c, some-array.c
• Use dashed notation for URLs: http://konstantinbender.com/introducing-the-metal-runtime
• Use dashed notation for XML, HTML and CSS: person-name, table-of-people, regular-xml-parser
• No arbitrary abbreviations, such as src, mod, obj, ...
• Source must be "white-space-clean", the white command line utility will cleanup whitespace for you
• Use semantic versioning for releases

License

Released under the MIT license.

Copyright (c) 2014 Konstantin Bender.

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.