diff options
| -rw-r--r--[-rwxr-xr-x] | README.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md index dff4cd9..b38e665 100755..100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ makesite.py =========== + Take full control of your static website/blog generation by writing your own simple, lightweight, and magic-free static site generator in Python. That's right! Reinvent the wheel! @@ -15,12 +16,14 @@ Python. That's right! Reinvent the wheel! Contents -------- + * [Introduction](#introduction) * [But Why?](#but-why) * [Get Started](#get-started) * [The Code](#the-code) * [Layout](#layout) * [Content](#content) +* [FAQ](#faq) * [Credits](#credits) * [License](#license) * [Support](#support) @@ -28,6 +31,7 @@ Contents Introduction ------------ + This repository contains the source code of an example website containing two static blogs and a few static pages. The website can be generated by running [makesite.py](makesite.py). The output looks like @@ -46,6 +50,7 @@ just the way you want it. But Why? -------- + For fun and profit! Okay, maybe not for profit, but hopefully for fun. Have you used a popular static site generator like Jekyll to generate @@ -78,6 +83,7 @@ customize the look and feel of your website to your satisfaction. Get Started ----------- + This section provides some quick steps to get you off the ground as quickly as possible. @@ -145,6 +151,7 @@ quickly as possible. The Code -------- + Now that you know how to generate the static website that comes with this project, it is time to see what [makesite.py](makesite.py) does. You probably don't really need to read the entire section. The source @@ -314,6 +321,7 @@ for `'news'` along with its content at [content/news](content/news). Layout ------ + In this project, the layout template files are located in the [layout directory](layout). But they don't necessarily have to be there. You can place the layout files wherever you want and update @@ -341,6 +349,7 @@ such as [Jinja2](http://jinja.pocoo.org/) or Content ------- + In this project, the content files are located in the [content directory](content). Most of the content files are written in HTML. However, the content files for the blog named [blog](content/blog) are @@ -387,8 +396,68 @@ can be done in two ways: post_layout, blog='blog', render='yes', **params) +FAQ +--- + +Here are some frequently asked questions along with answers to them: + + 1. Can you add feature X to this project? + + I do not have any plans to add new features to this project. It is + intended to be as minimal and as simple as reasonably possible. This + project is meant to be a quick-starter-kit for developers who want + to develop their own static site generators. Someone who needs more + features is free to fork this project repository and customize the + project as per their needs in their own fork. + + 2. Can you add support for Jinja templates, YAML front matter, etc.? + + I will not add or accept support for Jinja templates, YAML front + matter, etc. in this project. However, you can do so in your fork. + The reasons are explained in the first point. + + 3. Do you accept any new features from the contributors? + + I do not accept any new features in this project. The reasons are + explained in the first point. + + 4. Do you accept bug fixes and improvements? + + Yes, I accept bug fixes and minor improvements that do not increase + the scope and complexity of this project. + + 5. Are there any contribution guidelines? + + Yes, please see [CONTRIBUTING.md](CONTRIBUTING.md). + + 6. How do I add my own copyright notice to the source code without + violating the terms of license while customizing this project in my + own fork? + + This project is released under the terms of the MIT license. One of + the terms of the license is that the original copyright notice and + the license text must be preserved. However, at the same time, when + you edit and customize this project in your own fork, you hold the + copyright to your changes. To fulfill both conditions, please add + your own copyright notice above the original copyright notice and + clarify that your software is a derivative of the original. + + Here is an example of such a notice where a person named J. Doe + wants to reserve all rights to their changes: + + # Copyright (c) 2018-2019 J. Doe + # All rights reserved + + # This software is a derivative of the original makesite.py. + # The license text of the original makesite.py is included below. + + Anything similar to the above notice or something to this effect is + sufficient. + + Credits ------- + Thanks to: - [Susam Pal](https://github.com/susam) for the initial documentation @@ -399,6 +468,7 @@ Thanks to: License ------- + This is free and open source software. You can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of it, under the terms of the [MIT License](LICENSE.md). @@ -409,5 +479,6 @@ express or implied. See the [MIT License](LICENSE.md) for details. Support ------- + To report bugs, suggest improvements, or ask questions, please visit <https://github.com/sunainapai/makesite/issues>. |