(In-progress) Streamline creation of development environment and add usage documentation.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,53 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]"
+labels: bug
+body: 
+  - type: textarea
+    id: issue
+    attributes:
+      label: Description of the issue
+      description: What's the issue you encountered?
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: How can the issue be reproduced?
+      placeholder: Describe each step as precisely as possible
+    validations:
+      required: true
+      # TODO: Figure out banana logger :|
+  #
+  # - type: textarea
+  #   id: log
+  #   attributes:
+  #     label: Log file
+  #     description: loggy loggy
+  #   validations:
+  #     required: true
+  - type: input
+    id: version
+    attributes:
+      label: Neovim Version
+      description: In your terminal, run `nvim --version`
+      placeholder: "e.g. 0.10.1"
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Minimal Snippet
+      description: For ease of replication in the case of complex behaviour, paste a small snippet with which the bug occurs.    
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context?
+      description: |
+        - Additional info about your environment:
+        - Any other information relevant to your issue.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,25 @@
+name: Feature Request
+description: Suggest a new feature.
+title: "[Feature Request]"
+body:
+  - type: textarea
+    id: overview
+    attributes:
+      label: Overview
+      description: Include the basic, high-level concepts for this feature here. If this is an API request, please provide a link to the browser documentation.
+    validations:
+      required: true
+  - type: textarea
+    id: details
+    attributes:
+      label: Smaller details
+      description: These may include specific methods of implementation etc. Take a look at `TODO.md` in order to see if your request is related to any other planned features.
+    validations:
+      required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Why would this feature be useful?
+      description: This could include a specific project scenario, or a common inefficiency you have noticed.
+    validations:
+      required: true

USAGE.md

@@ -0,0 +1,74 @@
+# Usage
+
+Below is a minimal config for using banana during development:
+
+```lua
+return {
+    dir = "~/path/to/project/directory",
+    build = function() 
+        require("banana").installTsParsers()
+    end,
+    config = function()
+        require("banana").initTsParsers()
+    end,
+}
+```
+
+Because banana uses custom parsers for nml and ncss, they must be registered and compiled manually by treesitter. With this config, you are able to get fancy-schmancy syntax highlighting for ncss and nml.
+
+## Project Setup
+
+Banana's hello world uses the below directory structure:
+
+```
+PWD
+├── jumpstart.lua
+├── banana
+│   └── random_name
+│       └── index.nml
+└── lua
+    └── example
+        └── init.lua
+```
+
+The `jumpstart.lua` file will contain the following code, which will not change:
+
+```lua
+-- jumpstart.lua
+
+local instance = require("banana").newInstance("stuff/clock", "random buffer name")
+
+vim.keymap.set("n", "<leader>o", function()
+    instance:open()
+end, {})
+```
+
+By sourcing this file using the `:so` command, you are able to toggle opening and closing the banana page instance. This file is used for launching pages directly. If you want to launch your page later, as part of your plugin logic, then all you need to do is place these lines in whatever configuration that your plugin needs.
+
+Notice that the banana nml package and the lua package don't have the same name. Banana does not require any sort of name coupling between the names of packages requiring each other; you can expect banana's require to have similar behaviour to that of lua's require. (Remember that banana uses "/" instead of ".")
+
+## Project Content
+
+Alright, enough preamble, it's time to get to the fun part. One thing that's important to remember when developing a banana plugin is that the nml is your entry point into your banana page; all of your lua scripts are called from that nml page. With that in mind, let's take a look at the following nml file:
+
+```html
+<nml>
+  <head>
+    <style>
+      nml {
+        width: 50%;
+        height: 50%;
+      }
+      div {
+        hl-bg: red;
+        width: 50%;
+      }
+    </style>
+  </head>
+  <body>
+    <div>Hello World!</div>
+  </body>
+</nml>
+```
+
+Awfully underwhelming, huh?

lua/banana/init.lua

@@ -1,4 +1,3 @@
-local M = {}
 local counterInst = nil
 local todoInst = nil
 local instance = nil
@@ -7,9 +6,58 @@ local inst = nil
 local render = require("banana.lazyRequire")("banana.instance")
 local ffi = require("ffi")
 
+---@class Banana
+---@field newInstance function
+---@field emptyInstance function
+---@field getInstance function
+---@field getNilAst function
+---@field listInstanceIds function
+---@field examples table
+local M = {
+    newInstance = render.newInstance,
+    emptyInstance = render.emptyInstance,
+    getInstance = render.getInstance,
+    getNilAst = render.getNilAst,
+    listInstanceIds = render.listInstanceIds,
+}
+
+
 local tsInit = false
 local tsInstall = false
 
+---@class Banana.Examples
+---@field runCounter function
+---@field runTodo function
+---@field runLazy function
+M.examples = {
+    runCounter = function ()
+        if counterInst == nil then
+            counterInst = M.newInstance("examples/counter", "asdf")
+            -- instance.DEBUG = true
+        end
+        counterInst:open()
+    end,
+
+    runTodo = function ()
+        if todoInst == nil then
+            todoInst = M.newInstance("examples/todo", "asdf")
+            -- instance.DEBUG = true
+        end
+        todoInst:open()
+    end,
+
+    runLazy = function ()
+        if instance == nil then
+            instance = M.newInstance("examples/lazy", "")
+            -- instance.DEBUG = true
+            -- instance.DEBUG_showPerf = true
+            -- instance.DEBUG_stressTest = true
+        end
+        instance:open()
+        instance:_requestRender()
+    end,
+}
+
 M.test = {
     grid = function ()
         -- print(jit.status())
@@ -36,32 +84,6 @@ M.test = {
     end
 }
 
-M.runCounter = function ()
-    if counterInst == nil then
-        counterInst = render.newInstance("examples/counter", "asdf")
-        -- instance.DEBUG = true
-    end
-    counterInst:open()
-end
-M.runTodo = function ()
-    if todoInst == nil then
-        todoInst = render.newInstance("examples/todo", "asdf")
-        -- instance.DEBUG = true
-    end
-    todoInst:open()
-end
-
-M.runLazy = function ()
-    if instance == nil then
-        instance = render.newInstance("examples/lazy", "")
-        -- instance.DEBUG = true
-        -- instance.DEBUG_showPerf = true
-        -- instance.DEBUG_stressTest = true
-    end
-    instance:open()
-    instance:_requestRender()
-end
-
 function M.spam()
     local testFile = [[
 			.asdf {
@@ -110,6 +132,8 @@ function M.initTsParsers()
     end
     tsInit = true
     local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
+
+    vim.filetype.add({ extension = { nml = "nml" } })
     vim.treesitter.language.register("nml", "nml")
     ---@diagnostic disable-next-line: inject-field
     parser_config.nml = {
@@ -122,6 +146,9 @@ function M.initTsParsers()
         },
         filetype = "nml",
     }
+
+    vim.filetype.add({ extension = { ncss = "ncss" } })
+    vim.treesitter.language.register("ncss", "ncss")
     ---@diagnostic disable-next-line: inject-field
     parser_config.ncss = {
         install_info = {
@@ -133,7 +160,6 @@ function M.initTsParsers()
         },
         filetype = "ncss",
     }
-    vim.treesitter.language.register("ncss", "ncss")
 end
 
 return M