Starts formatting documentation to markdown

This commit is contained in:
2012-09-13 18:23:10 +02:00
parent fb45c9f6cd
commit 8b707e7f99
3 changed files with 62 additions and 44 deletions

View File

@@ -3,20 +3,28 @@ Tags: face recognition, image processing, computer vision, python, openCV, Ivolu
Slug: Ivolution
Welcome on the webiste on the Ivolution project !
## Welcome on the website of the Ivolution project !
Ivolution is a face timelapse generator.
Ivolution is a __face timelapse generator__.
Feed it with a bunch of images and it will generate a movie with your face centered on the screen.
Here is a small demonstration of what Ivolution can achieve :
http://www.youtube.com/watch?v=9ZpKnSjvmXo
[Video Ivolution at work here](http://www.youtube.com/watch?v=9ZpKnSjvmXo)
Ivolution uses face recognition and modifies the images so that your face always keeps the same size and location over the movie.
Images are processed in chronological order, so that you can see your face evoluate over time !
Ivolution uses __face detection__ and modifies the images so that your face always keeps the same size and location over the movie.
Images are processed in __chronological order__, so that you can see your face evoluate over time !
Ivolution currently supports Windows and Linux, and was successfully tested on Windows XP, 7 and Ubuntu 12.04.
Ivolution uses a really simple interface, so that you timelapse is only two clicks from being generated !
Here is what the current interface looks like :
[Image mp1 here]
Ivolution currently supports Windows and Linux and was successfully tested on Windows XP, 7 and Ubuntu 12.04.
Ivolution is currently still in early development, and you may face bugs or feel like critical features are missing.
In this case, just let me know by sending me a mail or by filing a bug here. I'll be glad to help you !
In this case, just let me know by [sending me a mail](ivolution_app@gmail.com) or by [filing a bug here](https://github.com/jlengrand/FaceMovie/issues?state=open). I'll be glad to help you !

View File

@@ -3,62 +3,65 @@ Tags: face recognition, image processing, computer vision, python, openCV, Ivolu
Slug: Installation
Ivolution should run on most of Windows, Linux and Mac operating systems.
__Ivolution should run on most of Windows, Linux and Mac operating systems.__
It was successfully tested on Windows 7, Windows XP and Ubuntu 12.04.
Depending on your operating system, the installation step may require a bit more work.
Depending on your operating system though (understand Linux users :), the installation step may require a bit more work.
Please choose below the chapter corresponding to your operating system
Windows (XP, Vista, Seven)
## Windows (XP, Vista, Seven)
Simply download and run the executable here (x86).
[Simply download and run the executable](link to installer)(x86).
Once installed, you should be able to run Ivolution through the icon on the Desktop.
Everything should work out of the box without issue.
The software has not been tested (yet) on Windows 8, but there should not be major problems to get it running.
Ubuntu 12.04
## Ubuntu 12.04
Ivolution is available in Ubuntu in only a few simple steps.
Ivolution is available for Ubuntu in only a few simple steps.
First of all, install Ivolution's dependencies. You can simply do this by running the following line in a terminal :
apt-get install . . .
Note : You'll need administrator's rights to install the packages (usually means using sudo).
[Insert proper command line here]
Then, download the last stable packages here and extract here where you want.
*___Note__ : You'll need administrator's rights to install the packages (usually means using __sudo__).*
Finally, move to the extracted folder in a command line and install the package
python setup.py install --record ivolution_files
This time again, you will need administrator's right.
Then, __[download the last stable packages](link to downloads)__ and extract here where you want.
Done ! You can now start using Ivolution by running
Ivolutioner
Finally, move to the extracted folder in command line and install the package
[python setup.py install --record ivolution_files]
*This time again, you will need administrator's right.*
__Done !__ You can now start using Ivolution by running
[Ivolutioner]
in a terminal.
Note:
The --record option during the install is used to create a list of all the files generated into your system.
By default, there is no uninstall solution for python packages and the only solution is to remove all the files one by one.
*__Note:__*
*The __--record__ option during the install is used to create a list of all the files generated into your system.*
*By default, there is no uninstall solution for python packages and the only solution is to remove all the files one by one.*
You can do this by running
[proper command line to uninstall]
in a command line, where *ivolution_file* is your record file.
in a command line, where ivolution_file is your record file.
**WARNING: This command, if not run correctly, may cause damages! Check the record file first.**
WARNING: This command, if not run correctly, may cause damages! Check the record file first.
## Other Linux Distributions
Linux
For most of all the other Linux distributions, the installation process is similar as the Ubuntu solution but for the first step.
For most of all the other Linux distributions, the installation process is similar as the Ubuntu solution __but for the first step__.
You will have to find the name of the packages for your own distribution, or compile them from source if they don't exist.
Here is a list of all the elements you'll need in your system to run Ivolution:
[place list of dependencies here]
Once all the dependencies are satisfied, you can simply download and install the package using the directions from the Ubuntu chapter.
Once all the dependencies are satisfied, you can simply [download](link to Linux package) and install the package using the directions [from the Ubuntu chapter](link to above? ).
Mac OS
## Mac OS
Up to now, I was not able to create application installer as for Windows.
Mac users should for now follow the Linux guide to install Ivolution.
__Mac users should for now follow the Linux guide to install Ivolution.__
An installer may be provided in the future.
You can also try to create it by yourself, using py2app (and in this case, let me know !)
You can also try to create it by yourself, using [py2app](link to py2app) (__and in this case, let me know !__)

View File

@@ -3,31 +3,38 @@ Tags: face recognition, image processing, computer vision, python, openCV, Ivolu
Slug: OneMinuteTutorial
Coz' 1 minute is faster than 5 minutes. . . here is a light speed fast tutorial
## Coz' 1 minute is faster than 5 minutes. . . here is a light speed fast tutorial
This page aims at putting you on rails as fast as possible, so that you can see what Ivolution is capable of by yourself, and in less than 5 minutes.
First of all, download the version of Ivolution corresponding to your operating system here.
Then, download the set of samples that you are going to use here, and extract the archive where you want.
This page aims at putting you on rails __as fast as possible__, so that you can see what Ivolution is capable of by yourself __in less than 5 minutes__.
First of all, __[download](link to Download page)__ the version of Ivolution corresponding to your operating system here.
Then, __[download the set of samples](link to samples directly)__ that you are going to use here, and extract the archive where you want.
Install the Ivolution and run it.
You should now see the main frame of the application.
Click on the input folder, and select the location of the samples.
[Image omko1 here]
Click on start, and wait for the processing to end.
[Image omko2 here]
Here is what you should get once everything is finished :
Done ! You can now watch the timelapse generated from the images.
The timelapse is saved in your Video folder by default.
For Windows users, it should be C:\Users\myUser\Videos, and for Ubuntu users /home/myUser/Videos.
For more option, have a look at the basic part of the documentation.
[Image omko3 here]
__Done !__ You can now watch the timelapse generated from the images.
The timelapse is saved in your __Video folder__ by default.
For Windows users, it should be *C:\Users\myUser\Videos*, and for Ubuntu users */home/myUser/Videos*.
For more option, have a look at the __[basic part of the documentation](link to basic doc)__.