aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2025-05-08 18:03:02 -0500
committerChristian Cleberg <hello@cleberg.net>2025-05-08 18:03:02 -0500
commitc3816f43b7f58d195157293991d83297abc0f23f (patch)
tree7e2f3d1071a3192bc3ce405aac6a36fff83455cd
parent0cd14b83aed38dfb119ac3c2b3d8103d39042e6e (diff)
downloadcleberg.net-c3816f43b7f58d195157293991d83297abc0f23f.tar.gz
cleberg.net-c3816f43b7f58d195157293991d83297abc0f23f.tar.bz2
cleberg.net-c3816f43b7f58d195157293991d83297abc0f23f.zip
update: README
-rw-r--r--README.md86
-rw-r--r--README.org79
-rw-r--r--screenshots/dark.pngbin0 -> 158697 bytes
-rw-r--r--screenshots/light.pngbin0 -> 153242 bytes
4 files changed, 79 insertions, 86 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index b395d33..0000000
--- a/README.md
+++ /dev/null
@@ -1,86 +0,0 @@
-# cleberg.net
-
-[cleberg.net](https://cleberg.net) is my personal webpage and blog. This
-website and blog utilize the powerful Org-Mode publishing system,
-courtesy of the [weblorg](https://github.com/emacs-love/weblorg) Emacs
-package.
-
-## Features & Configuration
-
-This site leverages the flexibility of Org-Mode to allow for easy
-customization through a simple `publish.el` file. For those
-who are interested in tweaking the underlying configuration, the weblorg
-documentation provides all necessary details on possible settings and
-options.
-
-## Getting Started
-
-To begin exploring or contributing to this project, you\'ll first need
-to set up a local copy of the repository. This can be accomplished by
-running the following commands within Emacs:
-
-```shell
-git clone https://github.com/ccleberg/cleberg.net && \
-cd cleberg.net && \
-emacs -nw
-```
-
-Alternatively, if you prefer working with Doom, simply open any of the
-repository files using `Spc f f` and selecting
-`README.org`. From there, feel free to make any necessary
-changes or customizations.
-
-## Building & Publishing the Site
-
-To test the site locally within Emacs, run the following command
-sequence:
-
-Use the `ENV` environment variable to determine which base
-URL weblorg will use. If ENV is omitted, it will default to
-`localhost:8000`. If `ENV=prod`, weblorg will look
-in the `publish.el` file for the production base URL.
-
-```shell
-# production:
-ENV=prod emacs --script publish.el
-
-# development:
-emacs --script publish.el
-```
-
-The resulting files can then be deployed to your desired target using
-any method of your choice, such as `scp` or SFTP.
-
-Alternatively, you may prefer to utilize the provided
-`build.sh` script to automate this process. To do so, simply
-customize and run the script as needed.
-
-```shell
-# production:
-ENV=prod ./build.sh
-
-# development:
-./build.sh
-```
-
-### Creating New Blog Posts
-
-To quickly create a new blog post within Emacs, follow these steps:
-
-1. Run `C-x C-f` (`SPC f f` in Doom) to open a
- new Org-Mode file.
-2. Utilize the `insert-file-contents` command by pressing
- `C-x i`.
-3. Direct the contents of `template.org` (located at
- `utils/template.org`) into the newly opened file.
-
-This streamlined process allows you to rapidly generate fresh content
-for cleberg.net, taking advantage of the existing template structure and
-formatting.
-
-## Contributing & Tasks
-
-For those interested in contributing to this project or addressing any
-outstanding issues, please refer to the issues tab. This is where you
-can find a comprehensive list of open tickets or submit a new ticket for
-consideration.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..16f4a2b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,79 @@
+* cleberg.net
+
+[[https://cleberg.net][cleberg.net]] is my personal web page and blog. This website and blog utilize the
+powerful Org-Mode publishing system, courtesy of the [[https://github.com/emacs-love/weblorg][weblorg]] Emacs package.
+
+| Light Mode | Dark Mode |
+|-------------------------+------------------------|
+| [[./screenshots/light.png]] | [[./screenshots/dark.png]] |
+
+** Features & Configuration
+
+This site leverages the flexibility of Org-Mode to allow for easy customization
+through a simple =publish.el= file. For those who are interested in tweaking the
+underlying configuration, the weblorg documentation provides all necessary
+details on possible settings and options.
+
+** Getting Started
+
+To begin exploring or contributing to this project, you'll first need to set up
+a local copy of the repository. This can be accomplished by running the
+following commands within Emacs:
+
+#+begin_src shell
+git clone https://github.com/ccleberg/cleberg.net && \
+cd cleberg.net && \
+emacs -nw
+#+end_src
+
+Alternatively, if you prefer working with Doom, simply open any of the
+repository files using =Spc f f= and selecting =README.org=. From there, feel
+free to make any necessary changes or customizations.
+
+** Building & Publishing the Site
+
+To test the site locally within Emacs, run the following command sequence:
+
+Use the =ENV= environment variable to determine which base URL weblorg will use.
+If ENV is omitted, it will default to =localhost:8000=. If =ENV=prod=, weblorg
+will look in the =publish.el= file for the production base URL.
+
+#+begin_src shell
+# production:
+ENV=prod emacs --script publish.el
+
+# development:
+emacs --script publish.el
+#+end_src
+
+The resulting files can then be deployed to your desired target using any method
+of your choice, such as =scp= or SFTP.
+
+Alternatively, you may prefer to utilize the provided =build.sh= script to
+automate this process. To do so, simply customize and run the script as needed.
+
+#+begin_src shell
+# production:
+ENV=prod ./build.sh
+
+# development:
+./build.sh
+#+end_src
+
+*** Creating New Blog Posts
+
+To quickly create a new blog post within Emacs, follow these steps:
+
+1. Run =C-x C-f= (=SPC f f= in Doom) to open a new Org-Mode file.
+2. Utilize the =insert-file-contents= command by pressing =C-x i=.
+3. Direct the contents of =template.org= (located at =utils/template.org=) into
+ the newly opened file.
+
+This streamlined process allows you to rapidly generate fresh content for
+cleberg.net, taking advantage of the existing template structure and formatting.
+
+** Contributing & Tasks
+
+For those interested in contributing to this project or addressing any
+outstanding issues, please refer to the issues tab. This is where you can find a
+comprehensive list of open tickets or submit a new ticket for consideration.
diff --git a/screenshots/dark.png b/screenshots/dark.png
new file mode 100644
index 0000000..1db3ee8
--- /dev/null
+++ b/screenshots/dark.png
Binary files differ
diff --git a/screenshots/light.png b/screenshots/light.png
new file mode 100644
index 0000000..9f07f43
--- /dev/null
+++ b/screenshots/light.png
Binary files differ