From df1486fd6cca716c4b985d1726b1899b2ee90591 Mon Sep 17 00:00:00 2001
From: Alex Pereira <alex.pereira.6464@gmail.com>
Date: Sat, 11 Mar 2023 00:20:42 -0500
Subject: [PATCH] Updated README.md

Signed-off-by: Alex Pereira <alex.pereira.6464@gmail.com>
---
 README.md | 53 ++++++++++++++++++-----------------------------------
 1 file changed, 18 insertions(+), 35 deletions(-)

diff --git a/README.md b/README.md
index 13b9f8b..b930c41 100644
--- a/README.md
+++ b/README.md
@@ -1,48 +1,31 @@
 <h1> FRC-AprilTags </h1>
-<p>
-	A repository that contains code to will run on FRC 2199's Nvidia Jetson Nano coprocessor during the 2023 season.
-</p>
-
-<h2> Setting Up the Jetson </h2>
-<p>
-	Please see the instructions <a href="https://github.com/PIE-Cubed/2023-Jetson-Code/wiki/Setup#----setting-up-the-jetson-nano" target="_blank">here</a> for setting up a Nvidia Jetson Nano.
-</p>
-
-<h2> Prerequisites </h2>
-<p>
-	<ul>
-		<li>A <a href="https://www.python.org/downloads/" target="_blank">Python 3</a> environment (prefereably <a href="https://www.python.org/downloads/release/python-3106/" target="_blank">3.10.6</a>)</li>
-		<li>The <a href="https://pypi.org/project/opencv-contrib-python/" target="_blank">OpenCV Contributor</a> package</li>
-		<li>The <a href="https://pypi.org/project/numpy/" target="_blank">NumPy</a> package (should install with pupil-apriltags)</li>
-		<li>The <a href="https://pypi.org/project/robotpy/" target="_blank">RobotPy</a> package</li>
-		<li>The <a href="https://pypi.org/project/pupil-apriltags/" target="_blank">Pupil Apriltags</a> package</li>
-	</ul>
-</p>
-
-<h2> How to install on Linux </h2>
-<p>
-    On linux run the following commands in order from terminal:
-
-    sudo apt install python3 python3-dev python3-pip python3-pil python3-smbus git cmake ninja-build
+<a href = "https://pypi.org/project/FRC-AprilTags/">
+	<img src = "https://img.shields.io/pypi/v/frc-apriltags.svg">
+</a>
+<a href = 'https://frc-apriltags.readthedocs.io/en/latest/?badge=latest'>
+    <img src = 'https://readthedocs.org/projects/frc-apriltags/badge/?version=latest' alt='Documentation Status' />
+</a>
+<a href = "https://opensource.org/license/mit/">
+	<img src = "https://img.shields.io/badge/License-MIT-blue.svg">
+</a>
+<p>
+	<strong>FRC-Apriltags is a package developed by Alex Pereira, The Robo-Lions, and PIE3.</strong>
 </p>
 <p>
-
-    python3 -m pip install -U pip wheel setuptools frc-apriltags
+	This repository contains code to detect AprilTags from the tag16h5 family and send pertinent information to a RoboRio using NetworkTables.
 </p>
 
-<h2> How to install on Windows: </h2>
+<h1> Documentation </h1>
 <p>
-    Install <a href="https://www.python.org/downloads/release/python-3106/" target="_blank">Python 3.10.6</a> for Windows, being sure to add Python to PATH. Then, install the required packages using this command:</li>
-    
-    python.exe -m pip install -U pip wheel setuptools frc-apriltags
+	All documentation for FRC-AprilTags can be found <a href = "http://frc-apriltags.readthedocs.io/">here</a>.
 </p>
 
-<h2> Writing Programs for Jetson </h2>
+<h1> Installation </h1>
 <p>
-	This is addressed in the repository's wiki at <a href="https://github.com/PIE-Cubed/2023-Jetson-Code/wiki" target="_blank">https://github.com/PIE-Cubed/2023-Jetson-Code/wiki</a>.
+	Installation instructions can be found <a href = "https://frc-apriltags.readthedocs.io/en/stable/getting_started.html">here</a>.
 </p>
 
-<h2> More details </h2>
+<h1> License </h1>
 <p>
-	If you'd like to learn more, all of these sections (and more!) will be explained in greater detail in the repository's wiki at <a href="https://github.com/PIE-Cubed/2023-Jetson-Code/wiki" target="_blank">https://github.com/PIE-Cubed/2023-Jetson-Code/wiki</a>.
+	See the license <a href = "https://github.com/PIE-Cubed/FRC-AprilTags/blob/main/LICENSE.txt">here</a>.
 </p>
\ No newline at end of file