commit 14fa3fc15ee1f70de85fd04ca0aeaeb242eb9ccf parent 7a2bd32134686b282e1dc0cb6aa129b92be16ebb Author: Tyler Clark <tyler.clark@foxide.xyz> Date: Sun, 9 Feb 2025 21:47:07 -0500 Updating README Diffstat:
| M | README.md | | | 15 | +++++++++++++-- |
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md @@ -1,3 +1,15 @@ # MinimalistGit +This project is designed to help automate and simplify setting up a minimalist Git server. +It is geared for individuals or small groups that do not need all of the features that something like Gitea would bring. +The end result of the script should look something like [Suckless's Git Page](http://git.suckless.org/). -A script to create a minimalist Git server. -\ No newline at end of file +# Requirements +This project has only has a few requirements to get up and running, the primary one being Git itself. + +- Unix host with POSIX compliant shell +- Git +- Web server (optional) +- [stagit](https://git.codemadness.org/stagit/) + +The web server and Stagit are only required if there is a desire for the Git server to have a web interface. +If it will only be used via CLI, then there is no need to install either.