diff --git a/README.md b/README.md index e69de29..1e2f062 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# 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. A preview is also automaticaly genereated for PRs made from branches local to this repository (require push/write permission). + +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 and refresh 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. + diff --git a/docker-compose.yml b/docker-compose.yml index 1191885..5ece0a7 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,7 @@ services: working_dir: /appdata ports: - "4000:4000" + - "35729:35729" stdin_open: true tty: true hostname: jekyll.local diff --git a/docker/jekyll/Dockerfile b/docker/jekyll/Dockerfile index e5a57eb..1313b96 100644 --- a/docker/jekyll/Dockerfile +++ b/docker/jekyll/Dockerfile @@ -40,4 +40,4 @@ RUN echo "gem: --no-document --user-install --bindir /home/${user}/bin" >> /home ENV PATH=/home/${user}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin ENTRYPOINT ["jekyll"] -CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental"] +CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental", "--livereload"]