aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2024-10-31 10:05:34 -0500
committerChristian Cleberg <hello@cleberg.net>2024-10-31 10:05:34 -0500
commitfa22561095f3b520b2d89a37b3bed3b57166dc62 (patch)
tree2b6c1fd350f7216f1d17547ec6c3f38fe3cf8b7a /README.org
parenta3d8f8e709d6034a0a4e4c4e06d9e7a7112e1227 (diff)
downloadcleberg.net-fa22561095f3b520b2d89a37b3bed3b57166dc62.tar.gz
cleberg.net-fa22561095f3b520b2d89a37b3bed3b57166dc62.tar.bz2
cleberg.net-fa22561095f3b520b2d89a37b3bed3b57166dc62.zip
minor enhancements
Diffstat (limited to 'README.org')
-rw-r--r--README.org65
1 files changed, 40 insertions, 25 deletions
diff --git a/README.org b/README.org
index 03a6ede..f223076 100644
--- a/README.org
+++ b/README.org
@@ -1,19 +1,22 @@
-* cleberg.net
-
-[[https://cleberg.net][cleberg.net]] is my personal webpage and blog.
+#+title: README
-** Overview
+* cleberg.net
-This website & blog uses [[https://orgmode.org/][Org-Mode]], published with [[https://github.com/emacs-love/weblorg][weblorg]].
+[[https://cleberg.net][cleberg.net]] is my personal webpage 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.
-** Configuration
+** Features & Configuration
-All configuration options are available within the =publish.el= file. Refer to
-the weblorg documentation for further configuration options.
+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.
-** Building & Publishing
+** Getting Started with cleberg.net
-Local testing is available via [[https://www.gnu.org/software/emacs/][Emacs]] or through the command line.
+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 sh
git clone https://git.cleberg.net/cleberg.net.git && \
@@ -21,32 +24,44 @@ cd cleberg.net && \
emacs -nw
#+end_src
-Within Emacs, open any of the repository files. In Doom, I do this with =Spc f
-f= and selecting =README.org=. Make any changes necessary to customize the
-project.
+#+RESULTS:
+
+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.
-To publish, you can use the =build.sh= script (change the deployment target!) or
-you can run the following commands.
+** 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 ommitted, it will default to =localhost:8000=. If =ENV=prod=, weblorg
+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 sh
ENV=prod emacs --script publish.el
#+end_src
-The files will be published to the =.build= directory. You can deploy these
-files to the target through any number of methods, such as =scp= or SFTP.
+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.
+
+*** Creating New Blog Posts
-Alternatively, customize and run the =build.sh= script as needed.
+To quickly create a new blog post within Emacs, follow these steps:
-*** Tips
+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.
-You can quickly create a new blog post by running =C-x C-f= (=SPC f f= in Doom),
-running =C-x i= (=insert-file-contents=), and then direct it to the
-=template.org= file (e.g., =~/git/cleberg.net/utils/template.org=).
+This streamlined process allows you to rapidly generate fresh content for
+cleberg.net, taking advantage of the existing template structure and formatting.
-** Tasks
+** Contributing & Tasks
-Refer to the [[https://github.com/ccleberg/cleberg.net/issues][issues page]] for open tickets or to submit a new ticket.
+For those interested in contributing to this project or addressing any
+outstanding issues, please refer to the [[https://github.com/ccleberg/cleberg.net/issues][issues page]]. This is where you can find
+a comprehensive list of open tickets or submit a new ticket for consideration.