Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation and setup instructions #15

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
v1.1
- Added responsive design for mobile devices
- Mobile devices no longer load the background image to save the bandwidth and performance hit.

v1.2
- Improved a documentation
- Updated demo links
48 changes: 0 additions & 48 deletions README

This file was deleted.

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## The Personal Page
This simple one-page website is a way for people to have a very quick and easy personable website that aggregates your activity and positions a simple logo, a portrait and some description text in a nicely-formatted manner.

## Usage
1. Edit the `index.html` file with your own text.
2. Replace `monogram.png` with your own logo. Your initials will likely not be NH, but if they are, be smart and use your own little monogram/logo.
3. Replace `nh.bg` with your own portrait for the background. Don't impersonate me!
4. You can switch the position of the monogram and text as seen in http://timlum.com.
5. Upload all the files on your server, including the MIT and GPL licences.
6. If you don't have a server, you can use [github pages](https://help.github.com/articles/user-organization-and-project-pages). It's free.

## Demo
- http://nazhamid.com
- http://jenschuetz.com/
- http://timlum.com
- http://alextamoykin.com
- http://weightshift.com/memo/the-personal-page

## Gracias
- Naz Hamid for the [original work](http://nazhamid.com)
- Scott Robbin for [jQuery Backstretch plugin](http://srobbin.com/blog/jquery-plugins/jquery-backstretch/)

## License
This is licensed under the MIT and GPL licenses.