Merge pull request 'README.md: Add goals and how to build this web page.' (#22) from add-readme into main
All checks were successful
Jekyll / jekyll (push) Successful in 42s

Reviewed-on: #22
This commit is contained in:
bEn 2025-05-02 08:12:49 +00:00
commit 19870887ab
3 changed files with 25 additions and 1 deletions

View File

@ -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.

View File

@ -13,6 +13,7 @@ services:
working_dir: /appdata working_dir: /appdata
ports: ports:
- "4000:4000" - "4000:4000"
- "35729:35729"
stdin_open: true stdin_open: true
tty: true tty: true
hostname: jekyll.local hostname: jekyll.local

View File

@ -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 ENV PATH=/home/${user}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
ENTRYPOINT ["jekyll"] ENTRYPOINT ["jekyll"]
CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental"] CMD ["server", "--verbose", "--host", "0.0.0.0", "--incremental", "--livereload"]