Go to file

Lim Chee Aun 1ce9f5bbe4 Add config.json to make it even easier to configure things		2013-11-27 23:14:41 +08:00
config.json	Add config.json to make it even easier to configure things	2013-11-27 23:14:41 +08:00
index.html	Add config.json to make it even easier to configure things	2013-11-27 23:14:41 +08:00
life.example.md	Changes to make forking easier and less conflicts	2013-11-27 22:53:40 +08:00
README.md	Add more docs	2013-11-27 22:59:07 +08:00

README.md

Life

This is something that I've wanted to build for a long time. It's a timeline of important events in my life, visualized in a way my mind always imagine it. There was something called Lifepath.me but now it's gone. How about Facebook timeline? Meh.

So, this is it. Have a look at cheeaun.github.io/life.

Features

Super simple
No fancy formatting
No fancy setup
No fancy effects
Flexible datetimes because sometimes you don't remember the exact date of an event

How to contribute

Fork this project.
Write code.
Make pull requests.

How to setup your own Life

Fork this project.
git checkout -b gh-pages (or any branch name you like)
Make a copy life.example.md, rename it to life.md.
Add your life events into life.md.
Commit life.md (not in master branch).
git push origin gh-pages and publish to GitHub Pages.

How to upgrade your Life

git checkout master
git remote add cheeaun https://github.com/cheeaun/life.git
git fetch cheeaun and git merge cheeaun/master to upgrade to latest Life.
git checkout gh-pages and git merge master to sync changes back to GitHub Pages.

Learn more.

Datetime "syntax"

2000 - event that happen in that year
01/2000 - event that happen in that month/year
01/01/2000 - event that happen exactly in that date/month/year
2001-2005, 10/2001-02/03/2005 - event that happen within the two dates
~2005 - event that happen around the time in that year
2005-~ - event that happen from that year and beyond (now).

License

MIT