From: Harishankar <v.harishankar@gmail.com>
Date: Tue, 26 May 2020 14:18:21 +0000 (+0530)
Subject: Readme.md - added Section for customization and notes
X-Git-Url: https://harishankar.org/repos/?a=commitdiff_plain;p=biaweb2.git

Readme.md - added Section for customization and notes
Added section for customization and notes in Readme.md
---

diff --git a/Readme.md b/Readme.md
index 0384f5b..c28876b 100644
--- a/Readme.md
+++ b/Readme.md
@@ -337,4 +337,31 @@ The resources can then be linked from your individual pages with markdown like t
     ![My image](images/testimage.jpg)
 
 Since BiaWeb2 uses the `<base>` tag to define the base URL, the above code will work 
-from any location on your website. 
\ No newline at end of file
+from any location on your website. 
+
+## Further Customization and Notes
+
+* You can edit the contents of the _templates_ folder to get a more unique look and feel. 
+  Templates are just plain HTML bits with no logic (other than the template vars marked 
+  within curly braces). The __style.css.tpl__ file is the CSS bit that is embedded in 
+  all pages of the site. At present there is no way to get a different look and feel for
+  different categories or parts of the site.
+
+* The file __stringbits.txt__ contain general strings that are used to describe parts of
+  your website. This can also be customized, but each line stands for a particular item 
+  and should not be interchanged. Ensure that changes to a particular line describe the 
+  same item (in a different way). For example the text `List of Articles` may be substituted
+  by `List of Docs` or `Documents` but changing it to `Categories` will not make sense. 
+
+* The generated website from the default template should conform to HTML 5. If there are
+  any errors in the resultant HTML, please raise an 
+  [issue](https://gitlab.com/harishankarv/biaweb2/-/issues/new) to 
+  address it and it will be fixed. In general, please raise an issue for any bugs, 
+  feedback or feature requests. However, as far as features are concerned, there is no 
+  plan to make this a comprehensive website management tool. The key philosophy of this 
+  tool is simplicity and I plan to keep it that way.
+
+* __Limitation of RSS Feed:__ At present the RSS feed generated by the script in 
+  __feed.xml__ does not fetch any articles from sub-categories and only fetches articles from'
+  its own category. This may be addressed in the future, depending on whether this is seen
+  as necessary.
\ No newline at end of file