From bc9c7b0827c69f9be0bcf4766ba3e4797c8498d1 Mon Sep 17 00:00:00 2001 From: coltborg Date: Wed, 11 Sep 2024 09:49:00 -0500 Subject: [PATCH] Improve README --- .eleventyignore | 2 ++ .gitignore | 1 - README.md | 25 +++++++++++++++++++------ _drafts/.gitkeep | 0 4 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 .eleventyignore create mode 100644 _drafts/.gitkeep diff --git a/.eleventyignore b/.eleventyignore new file mode 100644 index 0000000..e886637 --- /dev/null +++ b/.eleventyignore @@ -0,0 +1,2 @@ +README.md +_drafts/ diff --git a/.gitignore b/.gitignore index f5d2a25..b296e85 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ node_modules/ -_drafts/ _site/ .cache .DS_store diff --git a/README.md b/README.md index 8960180..0757ab7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ # cyby.dev -A HTML and CSS blog about tech and stuff. +An 11ty blog for whatever musings I want to add to the internet. -## Setup +## Run locally -## Dependencies +- Pull down the repository to your local directory +- In the root of the project, install dependencies: -- HTML -- CSS -- GitHub Pages +```bash +npm install +``` +- While developing locally, you can serve on a local server with : + +```bash +npm run serve +``` + +- Navigate to `http:localhost:8080` in a browser. +- Make a change in a file, save the file, and the change will be reflected in the browser automatically, without a reload. + +## Deploy + +Currently using the default GitHub Pages basic deployment based on the `main` branch. diff --git a/_drafts/.gitkeep b/_drafts/.gitkeep new file mode 100644 index 0000000..e69de29