adding a bit more documentation, cleaning up readme

SinclairHudson · Sep 22, 2024 · b7cc682 · b7cc682
1 parent 3567480
commit b7cc682
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+## 📝 Contributing 📝
+
+This project uses docker, both for running the app itself and for development.
diff --git a/README.md b/README.md
@@ -12,11 +12,8 @@ A tool to track sports balls, and add interesting visual effects.
 
 It's very fun to apply to juggling 🤹 and sports 🏐🏀 videos.
 
-Running this project is fairly demanding.
-A GPU is very helpful for running the neural networks for ball detection quickly, but it isn't required.
-At minimum: **10GB** disk space.
 
-# 🔥 Application Quickstart 🔥
+## 🔥 Application Quickstart 🔥
 
 
 For Windows users, see the [Windows Installation Guide](docs/install_windows.md).
@@ -25,9 +22,14 @@ For MacOS users, see the [MacOS Installation Guide](docs/install_macos.md).
 After installation, you can refer to the [User Guide](docs/user_guide.md) for an
 overview of all the software has to offer.
 
+Running this project is fairly demanding.
+A GPU is very helpful for running the neural networks for ball detection quickly, but it isn't required.
+At minimum: **10GB** disk space.
+
 ---
 
 ## 📝 Contributing 📝
 
 Contributions are welcome! Open an issue or a pull request, and I'll get to it when I can.
+Please see [The Contributing Guidelines](CONTRIBUTING.md) before making a pull request; it will also help you get started with development.
 Adding new effects is an easy contribution to make, and a good place to start.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## 📝 Contributing 📝

		This project uses docker, both for running the app itself and for development.