New design of web site

LICENSE.temp → LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Tom Johnson
+Copyright (c) 2014 Tim O'Brien (t413)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,31 +1,90 @@
-## How to contribute to the documentation - Create a Pull request
+# GraphWalker Website & Documentation
 
-1) Fork this project
+This repository contains the GraphWalker website and documentation. The pre-built static site is in the `_site/` directory.
 
-2) Clone the forked project
+## Serving the Site Locally
 
-3) In the root of the folder of the cloned project, run following command:
+### Option 1: NixOS/Flakes Setup (Recommended)
+
+If you're on NixOS or have Nix installed, use the provided `flake.nix` for a reproducible dev environment:
+
+1. Enter the dev shell:
+   ```sh
+   nix flake update
+   nix develop
+   ```
+
+2. Inside the shell, serve the site using Python or Node:
+   ```sh
+   # Option A: Python HTTP server
+   python3 -m http.server 8000
+   ```
+   or
+   ```sh
+   # Option B: Node http-server
+   npx http-server -p 8000
+   ```
+
+3. Open your browser to `http://localhost:8000` to preview the site.
+
+### Option 2: Manual Setup (Linux, macOS, Windows)
+
+To serve the site without Nix, use any HTTP server pointing to the `_site/` directory:
 
 ```sh
-bundle update
+# Using Python
+cd _site/
+python3 -m http.server 8000
 ```
 
-4) Then start a local preview of the site:
+or
 
 ```sh
-jekyll serve
+# Using Node (install http-server globally first: npm install -g http-server)
+cd _site/
+http-server -p 8000
 ```
 
-5) Do all your changes. The site uses the Jekyll Documentation Theme. See appendix below.
+## Contributing
+
+### Making Changes
+
+1. Fork this repository.
+
+2. Clone your fork:
+   ```sh
+   git clone https://github.com/YOUR_USERNAME/graphwalker.github.io.git
+   cd graphwalker.github.io
+   ```
+
+3. Create a new branch for your changes:
+   ```sh
+   git checkout -b feature/your-feature-name
+   ```
+
+4. Make your changes to the documentation in the `docs/` directory. The site uses the **Jekyll Documentation Theme** (see Resources below).
+
+5. Build the site (regenerate `_site/`):
+   ```sh
+   jekyll build
+   ```
+
+6. Test your changes locally by serving the site (see "Serving the Site Locally" above).
 
-6) Commit and push
+7. Commit and push:
+   ```sh
+   git add .
+   git commit -m "Describe your changes"
+   git push origin feature/your-feature-name
+   ```
 
-7) From your fork on GitHub, create a new pull request
+8. Create a Pull Request on GitHub from your fork to the main repository.
 
-## Appendix
+## Resources & References
 
-* [Jekyll](https://jekyllrb.com/)
+* [Jekyll Documentation](https://jekyllrb.com/)
 * [Jekyll on GitHub Pages](https://jekyllrb.com/docs/github-pages/)
-* [Setting up your GitHub Pages site locally with Jekyll](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
+* [Setting up GitHub Pages with Jekyll](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
 * [Jekyll Documentation Theme](http://idratherbewriting.com/documentation-theme-jekyll/)
-* [Pull Request Tutorial](https://yangsu.github.io/pull-request-tutorial/)
+* [How to Make a Pull Request](https://yangsu.github.io/pull-request-tutorial/)
+* [Nix Flakes](https://nixos.wiki/wiki/Flakes)