Browse Source

add some initial info to readme

master
Charles Reid 3 years ago
commit
b92a997059
2 changed files with 52 additions and 0 deletions
  1. +20
    -0
      LICENSE
  2. +32
    -0
      README.md

+ 20
- 0
LICENSE View File

@@ -0,0 +1,20 @@
Copyright (c) 2018 Charles Reid

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


+ 32
- 0
README.md View File

@@ -0,0 +1,32 @@
# How Do I Pelican?

This is a simple explanation of how to get started
using Pelican to build a static site.
It will skip a lot of the details in the
interest of simplicity.

## Before You Start

You'll need to have Pelican installed.
If you want to use Markdown with Pelican,
you'll also need to install Markdown.

```
$ pip install markdown
$ pip install pelican
```


## Getting Started with Pelican

There are a few things you'll need to get started with Pelican:

* (required) `pelicanconf.py` - pelican configuration file
* (required) `content/` - directory containing materials to render into a static site
* (optional) theme - either a local directory containing a theme, or a system-wide pelican theme

Use the [magic-flying-pelican](https://github.com/charlesreid1/magic-flying-pelican)
repository as a seed repo for getting started with Pelican.




Loading…
Cancel
Save