From ea38125cd72df6c10beb32ee92739238d7eae248 Mon Sep 17 00:00:00 2001 From: Florian Sesser Date: Fri, 25 Apr 2025 10:20:00 +0000 Subject: [PATCH] README.md: Add goals and how to build this web page. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index e69de29..ab1975d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Web landing page for the Tahoe-LAFS project + +The goal of this web page is to represent the Tahoe-LAFS project to the public. + +It gives guidance on getting started for end-users, developers building with Tahoe-LAFS and hackers interested working on Tahoe-LAFS itself alike. + + +## Building + +This web page is built and deployed by CI. + +If you want to pre-view your changes on your local machine before pushing commits, you might want to start a development server. + +Issuing this command on a system with Docker runs a web server on http://localhost:4000/ that re-builds the page automatically on source file change: + +```sh +docker-compose up +``` + + +## Contributing + +We welcome contributions! Easiest is to open tickets or pull requests directly. If unsure, join the IRC or ask on the Tahoe-LAFS developer mailing list. +