krz/hn

A brutalist web client for Hacker News.

clone: git clone https://gitbay.org/krz/hn.git

2a57019b0c2d8fa5cb466aef23a3925488c47b84

unsigned

author: Christian Cleberg <hello@cleberg.net> · 2023-06-01T14:48:12Z

formalize README

 README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 75 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 194ffd1..c5efb6a 100644
--- a/README.md
+++ b/README.md
@@ -3,23 +3,36 @@
 [hn](https://hn.cleberg.net) is a simple front-end alternative for Hacker 
 News, focusing on privacy and simplicity.
 
-## TODO
+## Getting Started
 
-A scratch pad of ideas that may be useful to implement:
+These instructions will get you a copy of the project up and running on your 
+local machine for development and testing purposes. See deployment for notes on 
+how to deploy the project on a live system.
 
-- [ ] Add functionality to view item-specific page with comments.
-- [ ] Add functionality to view a user's profile.
-- [ ] Add functionality to load more items or paginate?
-- [ ] Add minimal CSS.
+### Prerequisites
 
-## Development
+- A web server (e.g., Nginx or Apache)
+- PHP
 
-This just uses plain PHP and HTML, no special package managers or development 
-tools needed. Just start editing the files with your favorite editor and use a 
-server with PHP if you want to view the results or deploy your own version.
+### Installing
+
+Install the dependencies, using the web server of your choice:
+
+```
+sudo apt install nginx-full php
+```
+
+Clone the repo:
+
+```
+git clone https://git.sr.ht/~cmc/hn/
+```
 
 ## Deployment
 
+Deployment is as easy as copying the code to your webroot. No special packages 
+or tools required.
+
 To deploy, ensure you have a publicly-available web server and configure it to 
 fallback with all errors to the `index.php` file rather than returning a `404` 
 error.
@@ -40,3 +53,55 @@ the directory you're serving the PHP file from:
 ```conf
 FallbackResource /index.php
 ```
+
+## Built With
+
+* [PHP](https://www.php.net/) - The scripting language
+* [HTML](https://html.spec.whatwg.org/multipage/) - The markup language
+
+## Contributing
+
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of 
+conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+This project currently doesn't use versioning. See the git log instead.
+
+## Authors
+
+* **CMC** - *Literally everything* - [cmc](https://sr.ht/~cmc/)
+
+## License
+
+This project is licensed under the Unlicense - see the 
+[LICENSE.md](LICENSE.md) file for details.
+
+## Acknowledgments
+
+* Hat tip to anyone whose code was used
+* Inspiration
+* etc
+
+------------------------------------
+
+# hn
+
+
+## TODO
+
+A scratch pad of ideas that may be useful to implement:
+
+- [ ] Add functionality to view item-specific page with comments.
+- [ ] Add functionality to view a user's profile.
+- [ ] Add functionality to load more items or paginate?
+- [ ] Add minimal CSS.
+
+## Development
+
+This just uses plain PHP and HTML, no special package managers or development 
+tools needed. Just start editing the files with your favorite editor and use a 
+server with PHP if you want to view the results or deploy your own version.
+
+## Deployment
+