From c2f3701c8c6b2b469e4cb7a143cac281d7fcc554 Mon Sep 17 00:00:00 2001
From: zontreck <tarapiccari@gmail.com>
Date: Fri, 14 Mar 2025 21:06:40 -0700
Subject: [PATCH] Introduce a Contributing info file

---
 CONTRIBUTING.md | 22 ++++++++++++++++++++++
 README.md       | 31 ++++++++++++++++++++++++++++++-
 2 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..dd4f62b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,22 @@
+# BugVault
+
+Welcome to BugVault!
+
+This project aims to create a fully featured bug tracker, written in Flutter, designed for ease of use, without compromising on functionality.
+
+## **IMPORTANT**
+
+This project uses Hungarian Notation. Any contributions must likewise use Hungarian Notation.
+
+Please see the table below for mappings. _NOTE_: All globals will use a `g_` prefix to indicate the variable is in a global context.
+
+| Prefix | Purpose          |
+| ------ | ---------------- |
+| s      | String           |
+| i      | Integer          |
+| b      | Boolean          |
+| ix     | Bitmask          |
+| v      | Vector           |
+| L/l    | List             |
+| d      | Double           |
+| m      | Map / Dictionary |
diff --git a/README.md b/README.md
index 2cd82ce..b9937da 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # BugVault
 
-Open Source GPL3 bug tracker. This bug tracker prioritizes ease of use.
\ No newline at end of file
+Open Source GPL3 bug tracker. This bug tracker prioritizes ease of use.
+
+# Compilation
+
+## Linux
+
+To build for Linux, you are going to want to run the following command:
+
+```bash
+flutter pub get
+flutter build linux
+```
+
+## Android
+
+To build for Android, run the following command:
+
+```bash
+flutter pub get
+flutter build apk
+```
+
+## Windows
+
+To build for Windows, run the following command:
+
+```bat
+flutter pub get
+flutter build windows
+```