Updated Home (markdown)

Tobias Reich 2013-11-18 05:38:00 -08:00
parent bd4c6adc1e
commit 99a606b9e3

21
Home.md

@ -8,7 +8,7 @@ To run Lychee, everything you need is a web-server with PHP 5.3 or later and a M
## Settings
Settings are located inside the `php/config.php`. All settings are optional and doesn't need to be changed. [Settings »](https://github.com/electerious/Lychee/wiki/Settings)
Settings are located inside the `php/config.php`. [Settings »](https://github.com/electerious/Lychee/wiki/Settings)
## How to use
@ -22,21 +22,34 @@ You can upload photos directly with every FTP client into Lychee. This feature h
This shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](https://github.com/electerious/Lychee/wiki/Keyboard-Shortcuts)
#### Twitter Cards
Lychee supports [Twitter Cards](https://dev.twitter.com/docs/cards) and [Open Graph](http://opengraphprotocol.org) for shared images (not albums). In order to use Twitter Cards you need to request an approval for your domain. Simply share an image with Lychee, copy its link and paste it in [Twitters Card Validator](https://dev.twitter.com/docs/cards/validation/validator).
## Browser Support
Lychee supports the latest versions of Google Chrome, Apple Safari and Mozilla Firefox. Photos you share with others can be viewed from every browser. For the best experience we are recommending to use Google Chrome or Apple Safari.
Lychee supports the latest versions of Google Chrome, Apple Safari, Mozilla Firefox and Opera. Photos you share with others can be viewed from every browser. For the best experience we are recommending to use Google Chrome or Apple Safari.
## Update
####From version 1.0/1.1/1.2 to 1.3:
####From version 1.0/1.1/1.2 to 1.3:
1. Replace all files, excluding `uploads/`
2. Open `php/config.php` and reconfigure your installation
3. Open `php/update.php` in your browser
## Extensions
| Name | Description | Link |
|:-----------|:------------|:------------|
| lycheesync | Command line interface tool to sync lychee with any directory containing photos | https://github.com/GustavePate/lycheesync |
## Troubleshooting
If Lychee is not working properly, try to open `php/check.php`. This file will take a look at your configuration and displays all errors it can find. Everything should work if you can see the message "Lychee is ready!".
If you experience problems uploading large amounts of photos, you might want to change the PHP parameters in `.htaccess` (if you are using the PHP Apache module) or in `.user.ini` (if you are using PHP >= 5.3 with CGI or FastCGI).
## About
Lychee is made by [Tobias Reich](http://electerious.com) (HTML, CSS, JS, Design, Website Design and Development) with the help of [Philipp Maurer](http://phinal.net) (PHP, MySQL).
@ -45,7 +58,7 @@ Lychee is made by [Tobias Reich](http://electerious.com) (HTML, CSS, JS, Design,
(MIT License)
Copyright (C) 2013 [Tobias Reich](http://electerious.com)
Copyright (C) 2013 [Tobias Reich](http://electerious.com)
Copyright (C) 2013 [Philipp Maurer](http://phinal.net)
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: