fix: convert README.org to README.md

1 files changed, 112 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f2be0d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,112 @@
+# 📊 Audit Tools by Christian Cleberg
+
+Welcome to **Audit Tools** — a collection of open-source Python scripts
+and resources designed to help auditors, risk professionals, and data
+analysts automate common audit tasks and analytics.
+
+Whether you're new to audit automation or an experienced tech-enabled
+auditor, this toolkit offers practical, real-world examples you can use,
+customize, and build upon.
+
+# 📦 What's Inside
+
+This repository contains Python scripts and templates for common audit
+procedures and control testing activities, including:
+
+- ✅ **Pseudo-Random Sampling**
+- ✅ **GITC Extractions and Analysis**
+- ✅ **Project Management Tracking & Visualizations**
+- ✅ **Cloud Platform Analysis (planned)**
+- ✅ **Audit AI Prompts & Guides (planned)**
+
+The goal is to provide practical, easy-to-understand tools that auditors
+and analysts can quickly deploy in their environments.
+
+# 🚀 Getting Started
+
+****Clone the Repository****
+
+``` bash
+git clone https://git.sr.ht/~cxc/audit-tools
+cd audit-tools
+```
+
+****Install Dependencies****
+
+*Required for Python scripts*
+
+``` bash
+pip install -r requirements.txt
+```
+
+****Run a Sample Script****
+
+Example: Run the **Linux OS Report** tool.
+
+``` bash
+./os/linux/report/linux.sh
+```
+
+View the results in your terminal or within the file created by the
+script.
+
+# 📖 Learn More
+
+If you're new to audit analytics or Python scripting, start here:
+
+- [Python for Auditors](https://realpython.com)
+- [Audit Analytics 101](https://audit-analytics.com)
+- [Intro to Pandas
+  Documentation](https://pandas.pydata.org/docs/getting_started/)
+
+Also, check out the `notebooks/` folder for interactive tutorials and
+use cases.
+
+# 🤝 How to Contribute
+
+Want to add your own audit scripts or improve existing ones?
+Contributions are welcome!
+
+****Ways to Help****
+
+- Submit new Python scripts for audit use cases.
+- Suggest enhancements or new features.
+- Improve documentation or write beginner-friendly tutorials.
+- Test existing tools on new datasets and report issues.
+
+****To Contribute****
+
+1.  Fork this repo
+
+2.  Create a new branch:
+
+    ``` bash
+    git checkout -b my-feature
+    ```
+
+3.  Commit your changes:
+
+    ``` bash
+    git commit -m 'Added new audit test'
+    ```
+
+4.  Push to the branch:
+
+    ``` bash
+    git push origin my-feature
+    ```
+
+5.  Open a Pull Request
+
+# 👤 About the Creator
+
+Made with ❤️ by [Christian Cleberg](https://cleberg.net/).
+
+I'm a technology assurance leader passionate about audit innovation, AI
+in audit, and building practical tools for auditors and risk
+professionals.
+
+# 📜 License
+
+This project is licensed under the **GNU General Public License v3.0** —
+see the [LICENSE](LICENSE) file for details.