From 10a3f830aa3e9f9672b82b16122de4673aee53fd Mon Sep 17 00:00:00 2001 From: Jeff MacKinnon Date: Thu, 31 Jul 2025 10:01:59 -0300 Subject: [PATCH] Added instructions to the readme --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5cda20..4090c74 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,35 @@ Use the example python notebook to get started. ## What we're missing -Tests, I haven't written any real tests for this set of libraries, yet. That will be coming soon, probably the next time that we have a slow time. \ No newline at end of file +Tests, I haven't written any real tests for this set of libraries, yet. That will be coming soon, probably the next time that we have a slow time. + +# Getting Started + +To use this set of tools you will need some rudimentary understanding of python. + +I suggest that you install: + +- Python 3 (any version) [link](https://www.python.org/downloads/) +- PIP (To manage modules) [link](https://pypi.org/project/pip/) +- VSCodium [link](https://vscodium.com) + +There are some python modules that are used heavily that you will need to, they all can be installed with ``pip``. Some may come pre-installed with the version of python that you install. + +- sys +- pandas +- numpy +- sqlite3 +- jinja2 +- tomllib + +There are also a few VSCodium extensions that will be needed. + +- Jupyter + +## Optional: + +My preferred way to manage this tool for multiple projects is using [git](https://git-scm.com/downloads). I will typically clone the entire repo and then work from there. + +# Future Features + +There are a lot of different features that I am planning, including building a web app that will allow this tool to be easily used from a browser, but before I get to that the largest feature that I need to figure out is how to install this as a module so that it can be called from any script that you want. \ No newline at end of file