lovr-docs
===

This repository contains the documentation for [LÖVR](https://github.com/bjornbytes/lovr).

There are five main types of documentation here:

- The **`api`** folder contains a Lua table with metadata for all LÖVR functions and objects.
  - This is used to generate documentation, but is also useful for integrating with other tools
  (e.g. autocomplete for the LÖVR API in text editors).
  - Each function, object, etc. has a Lua file that exports its metadata.  These are aggregated
  into a single table stored in `init.lua`.  The aggregator is a LÖVR script, you can run it by
  typing `lovr api` at the root of this repository.
- The **`examples`** folder contains small LÖVR projects demonstrating a specific task/technique.
  They aim to be minimal and easy to understand/copy.
  - The ones listed in the `init.lua` file are shown on the website.
- The **`showcase`** folder contains full LÖVR projects that implement entire games or demos.  The
  code is less important for these and it is more about the end result.
  - The ones listed in the `init.lua` file are shown on the website.
  - Also, each showcase project may contain its own `init.lua` with metadata about the project.
  Currently, this can contain an `author` table with `name` and `link` strings.
- The **`guides`** folder contains markdown files that explain LÖVR-related concepts in depth.
  - Similarly, `init.lua` contains a manifest used to populate the sidebar on the website.
- The **`tests`** folder contains small test cases, to make sure bugs stay fixed.
  - Each folder is a LÖVR project.
  - The test is considered failed if it throws a Lua error or crashes when run with LÖVR.
  - There isn't a runner yet.

Note that each release of LÖVR has its own branch.  Cherry picks are used to propagate fixes to
relevant branches as needed.  Which will totally scale.

All the code in the example/showcase projects is released under CC0.  However, the models, textures,
sounds, and other assets used may use different licensing, so be sure to double check those.
