No history found.

readme.txt:
umi
===

a static site generator

CAUTION: this script is still a work in progress and will be updated over time.


usage
-----

in an empty directory, run "umi -n" and a new file titled "umi.conf" will be created, along with
three directories: "content", "output", and "templates".

you can view the included example site (in the "example" directory) to view more information about
umi, as well as details about the newly created items.

for command-line help, just run "umi --help".


requirements
------------

umi only requires a python installation. the supported versions are:

- python2 2.7 (WIP)
- python3 3.7
- pypy2 2.7 (WIP)
- pypy3 3.7


install
-------

to "install" umi, clone the source code for umi into the folder "umi-src", then create a symlink
to "umi.py" somewhere that's in your "$PATH" lookup. (run "echo $PATH" to such locations.)

git clone https://rocketgit.com/user/dawning/umi umi-src
ln -s ~/path/to/umi-src/umi.py ~/.local/bin/umi

use "git fetch" and "git pull" to update your local umi repository.


license
-------

umi is licensed under the apache license, version 2.0. you read a copy in the included
"license.txt" file, or online at <http://www.apache.org/licenses/LICENSE-2.0.txt>
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/dawning/umi

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/dawning/umi

Clone this repository using git:
git clone git://git.rocketgit.com/user/dawning/umi

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main