aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.com>2021-11-20 00:08:54 +0200
committerkaotisk <kaotisk@arching-kaos.com>2021-11-20 00:08:54 +0200
commit4680df3e880be45c83a298002557fa6ac1b3a423 (patch)
tree9f15ca2f32e90730ad779ed49a9d16e1a18aa083 /README
parent7e57767f0c0355f808486111580be41c2f467a10 (diff)
download01-NEWS-4680df3e880be45c83a298002557fa6ac1b3a423.tar.gz
01-NEWS-4680df3e880be45c83a298002557fa6ac1b3a423.tar.bz2
01-NEWS-4680df3e880be45c83a298002557fa6ac1b3a423.zip
Packing to latest changes
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 24 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..299da25
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+Kaotisk Hund news repository
+============================
+(at last a git blog, lol)
+
+Description
+-----------
+I always wanted to post somewhere. I found that this way I could use git to maintain a history of changes.
+Some changes came along the way (see Migration tools).
+
+Usage
+-----
+- sh bin/add-new.sh
+ Creates a new file with name from the time you executed the command in form of 20010101_235959. After you are done editing, it renames it by adding your first line of the file in the name, replacing all letters with lowercase and spaces with underscores. Delimiter of the 2 attibutes is one dash "-".
+
+
+Migration tools
+---------------
+- utils/01-migrate.sh
+ Reads the title (first line of file) and puts in on the filename
+ Note: Make sure you don't use symbols other than letters and spaces in your titles
+
+- utils/02-migrate_to_folder.sh
+ Moves all articles to news folder
+ Note: the articles are recognized with "2" in filename :)