aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorWilliam Harrington <kb0iic@berzerkula.org>2025-02-11 20:56:24 -0600
committerWilliam Harrington <kb0iic@berzerkula.org>2025-02-11 20:56:24 -0600
commitc5d0b28a943d702357a67658fb88c25c82c7ce12 (patch)
tree0d4a21bc04413844b52006fa045de4d15efa98a1 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5189dbd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+# Project Title
+
+Builddb-sb
+
+## Description
+
+Spring Boot version of Builddb to keep track of installed files of an LFS build.
+
+## Getting Started
+
+### Dependencies
+
+* Java 17
+* Spring Boot 3
+* Maven
+* JPA
+* Thymeleaf
+
+### Installing
+
+* mvn clean compile install
+
+### Executing program
+
+* How to run the program
+* Step-by-step bullets
+```
+code blocks for commands
+```
+
+## Help
+
+Any advise for common problems or issues.
+```
+command to run if program contains helper info
+```
+
+## Authors
+
+Contributors names and contact info
+
+William Harrington
+kb0iic@berzerkula.org
+
+## Version History
+
+* 1.0.1
+ * Various bug fixes and optimizations
+ * See [commit change]() or See [release history]()
+* 1.0.0
+ * Initial Release
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details
+
+## Acknowledgments
+
+Inspiration, code snippets, etc.
+* [Spring Boot Tests for Controller, Service and Dao Layers](https://howtodoinjava.com/spring-boot/spring-boot-test-controller-service-dao/)
+* [BoostMyTool](https://www.youtube.com/@BoostMyTool/videos)
+* [Spring Boot Integration Test with TDD | JUnit5 & H2](https://www.youtube.com/@Javatechie/videos) \ No newline at end of file