aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2025-08-02 13:02:43 -0500
committerChristian Cleberg <hello@cleberg.net>2025-08-02 13:02:43 -0500
commitb598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c (patch)
tree5faf22af7a20ea6f7639fa3bdbde5210144959e6 /README.org
parenta24b16d1c04f396209d1e80168f5df12e79bc438 (diff)
downloadaudit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.tar.gz
audit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.tar.bz2
audit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.zip
fix: convert README.org to README.md
Diffstat (limited to 'README.org')
-rw-r--r--README.org102
1 files changed, 0 insertions, 102 deletions
diff --git a/README.org b/README.org
deleted file mode 100644
index 6e33faf..0000000
--- a/README.org
+++ /dev/null
@@ -1,102 +0,0 @@
-#+TITLE: Audit Tools by Christian Cleberg
-#+AUTHOR: Christian Cleberg
-#+OPTIONS: toc:nil
-
-* 📊 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**
-
-#+begin_src bash
-git clone https://git.sr.ht/~cxc/audit-tools
-cd audit-tools
-#+end_src
-
-**Install Dependencies**
-
-/Required for Python scripts/
-
-#+begin_src bash
-pip install -r requirements.txt
-#+end_src
-
-**Run a Sample Script**
-
-Example: Run the *Linux OS Report* tool.
-
-#+begin_src bash
-./os/linux/report/linux.sh
-#+end_src
-
-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:
-- [[https://realpython.com][Python for Auditors]]
-- [[https://audit-analytics.com][Audit Analytics 101]]
-- [[https://pandas.pydata.org/docs/getting_started/][Intro to Pandas Documentation]]
-
-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:
- #+begin_src bash
- git checkout -b my-feature
- #+end_src
-3. Commit your changes:
- #+begin_src bash
- git commit -m 'Added new audit test'
- #+end_src
-4. Push to the branch:
- #+begin_src bash
- git push origin my-feature
- #+end_src
-5. Open a Pull Request
-
-* 👤 About the Creator
-
-Made with ❤️ by [[https://cleberg.net/][Christian Cleberg]].
-
-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
-[[file:LICENSE][LICENSE]] file for details.