diff options
author | Kyle Meyer <kyle@kyleam.com> | 2014-02-08 00:41:00 -0500 |
---|---|---|
committer | Kyle Meyer <kyle@kyleam.com> | 2014-02-08 00:41:00 -0500 |
commit | 44415bcb8bca4814ecc3e4a34baa2999a5e3103a (patch) | |
tree | 8974dba9ccb6a34f67b3b5022c52af42063c8098 | |
parent | 8f4381025f64ff2ab59c60b65dc5ac42c9276a5b (diff) | |
download | bog-44415bcb8bca4814ecc3e4a34baa2999a5e3103a.tar.gz |
DOC: Make text version Github's preferred README
GitHub will choose README.org over README, which is not what I want
because the README text file is exported because GitHub doesn't render
Org files very well.
These changes rename the Org README so that the text version will be
displayed on GitHub.
-rw-r--r-- | bog-readme.org (renamed from README.org) | 0 | ||||
-rw-r--r-- | bog.el | 2 | ||||
-rw-r--r-- | readme-to-ascii.el | 2 |
3 files changed, 2 insertions, 2 deletions
diff --git a/README.org b/bog-readme.org index a3315ec..a3315ec 100644 --- a/README.org +++ b/bog-readme.org @@ -24,7 +24,7 @@ ;;; Commentary: ;; ;; Bog provides a few convenience functions for taking research notes in -;; Org mode. See README.org for more information. +;; Org mode. See README (or bog-readme.org) for more information. ;;; Code: diff --git a/readme-to-ascii.el b/readme-to-ascii.el index 5d28a34..2979d88 100644 --- a/readme-to-ascii.el +++ b/readme-to-ascii.el @@ -4,7 +4,7 @@ (add-to-list 'load-path org-location) (require 'org)) -(let ((readme-file "README.org") +(let ((readme-file "bog-readme.org") exported-file (final-file "README")) (with-current-buffer (find-file-noselect readme-file) |