README.md: Add goals and how to build this web page. #22
24
README.md
24
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:
|
||||
btlogy
commented
Maybe we should notify that the pages will not reload, so a refresh is still needed. I've been using Maybe we should notify that the pages will not reload, so a refresh is still needed.
I've been using `--livereload` elsewhere, but I've not yet implemented here...
|
||||
|
||||
```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.
|
||||
|
Loading…
Reference in New Issue
Block a user
To be complete, the CI is also providing a preview so contributor (w/ push/write permission in this repo) do not have to build locally.