Add documentation, license

Author: elizagamedev

LICENSE

@@ -0,0 +1,24 @@
+MIT License
+-----------
+
+Copyright (c) 2021 Eliza Velasquez
+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.

README.md

@@ -0,0 +1,60 @@
+# unity.el
+
+This package provides some Emacs integration with the Unity game engine. Most
+notably, it provides the ability to open source files from Unity in Emacs or
+Emacsclient while still generating the solution and project files for use with
+`lsp-mode`.
+
+Additionally, this package can install hooks/advice for smoother interop with
+certain Unity quirks.
+
+## Installation
+
+Currently, this package is not on M?ELPA. In the meantime, please clone and
+extend your load path. For example:
+
+```elisp
+(use-package 'unity
+  :load-path "site-lisp/unity.el"
+  :config
+  (unity-build-code-shim)
+  (unity-setup))
+```
+
+## Configuration
+
+`unity.el` exposes two functions, `unity-build-code-shim` and `unity-setup`.
+
+### `unity-build-code-shim`
+
+Unity does not generate project or solution files unless the external text
+editor is recognized as Visual Studio, Visual Studio Code, or MonoDevelop.
+Unfortunately, this means that other editors which wish to leverage the power of
+the OmniSharp language server are obtuse to use with Unity. `unity.el` provides
+a workaround for this issue: it compiles a very simple binary named
+`code`/`code.exe` which can be set as Unity's external editor to trick it into
+generating the solution/project files as normal.
+
+The shim simply invokes the remaining command line arguments as a command line.
+For example, the following command runs `emacsclient Foo.cs`.
+
+```sh
+code emacsclient Foo.cs
+```
+
+`unity-build-code-shim` will compile the shim, placing the resulting
+`code`/`code.exe` file in `[emacs-user-directory]/var/unity/`.
+
+You can then change the "External Script Editor" setting to point to `code` and
+adjust the "External Script Editor Args" arguments as such to run `emacsclient`
+(or any program of your choosing, for that matter).
+
+```sh
+emacsclient -n +$(Line):$(Column) $(File)
+```
+
+### `unity-setup`
+
+This function installs any hooks, advice, etc. necessary for smoother
+Emacs/Unity interop. Currently this is limited to advising `rename-file` so that
+`.meta` files are automatically moved alongside their associated files.

unity.el

@@ -1,5 +1,23 @@
 ;;; unity.el --- Unity integration for Emacs -*- lexical-binding:t -*-
+
+;; Version: 0.1.0
+;; Author: Eliza Velasquez
+;; Created: 30 May 2021
+;; Keywords: unity
+;; URL: https://github.com/elizagamedev/unity.el
+
 ;;; Commentary:
+
+;; This package provides some Emacs integration with the Unity game engine.
+;; Most notably, it provides the ability to open source files from Unity in
+;; Emacs or Emacsclient while still generating the solution and project files
+;; for use with `lsp-mode'.
+;;
+;; Additionally, this package can install hooks/advice for smoother interop with
+;; certain Unity quirks.
+;;
+;; See README.md for more information.
+
 ;;; Code:
 
 (defgroup unity nil