aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
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 :)