added files

1 files changed, 107 insertions, 0 deletions

diff --git a/h-source/README.txt b/h-source/README.txt
new file mode 100644
index 0000000..509d8db
--- /dev/null
+++ b/h-source/README.txt
@@ -0,0 +1,107 @@
+== Introduction ==
+
+h-source is a web software that can be used to build a community of people that want to share their hardware information. It is based on the EasyGiant PHP framework (www.easygiant.org) and can be considered an EasyGiant application
+
+
+== Installation and configuration ==
+
+In order to use h-source you have to install a web server that supports the URL rewrite feature (such as the Apache server with the mod_rewrite module installed), PHP 5.2 or newer and Mysql 5 or newer.
+
+
+Extract the tarball inside a folder of your filesystem.
+
+You have to create the MySQL database used by h-source. The tables of the database that have to be created are written inside the file tables.sql. A way to carry out this operation is the following:
+
+Open a terminal and type:
+
+	mysql -u <username> -p
+	
+where <username> is the database user. Write the password and type the following command:
+
+	create database <db>;
+	
+where <db> is the database name you want to use. Close Mysql by typing the following command:
+
+	exit
+	
+Now you have to move inside the folder that contains the tables.sql file and type the following command:
+
+	mysql -u username -ppassword <db> < tables.sql
+	
+where username and password have to be changed with the real username and password. <db> is the name of the database just created.
+
+Now you have created the database named <db>
+
+
+Open the Config/Config.php file
+
+You have to set the following constants:
+
+	DB: name of the database (the database just created)
+	USER: database user
+	PWD: database password
+	HOST: name of the mysql server (usually localhost)
+
+	DOMAIN_NAME: the domain name of the website (use localhost or create a virtual host in your web server)
+
+Now you have to copy the extracted h-source files inside the DocumentRoot of your server. You can choose to leave all the files inside the DocumentRoot or not, see the explanations in this page (http://www.easygiant.org/learn/index/6).
+
+You have now to assure that the allowOverride directive is active in the configuration file of your Apache server. You have to activate the allowOverride directive for the folder inside which you have saved the h-source files (and the index.php file). If you have not activated the allowOverride directive, then your URL won't be interpreted by the mod_rewrite module (you won't be able to use h-source). In a GNU/Linux system the apache configuration file is usually saved at /etc/apache2/apache2.conf.
+
+Direct your browser to the following URL:
+
+	http://DOMAIN_NAME/
+	
+where DOMAIN_NAME is the domain name you have previously set (perhaps localhost). You should see the home page of the h-source software.
+
+
+
+== Account issues ==
+
+If you want that the system can send e-mails you have to specify the name of the SMTP server that has to be used. Open the file Application/Include/params.php and set the following constants:
+
+	$mailServer = "";  //set the mail server
+	
+	$generalMail = "";  //set the username of your mail account
+	
+	$mailPassword = "";  //set the password of your mail account
+
+You can also set these constants:
+
+	$generalName = "";  //the string that you want to use inside the <title> tag of your website
+	
+	$projectName = "";  //the name of your project
+
+
+== Change the homepage ==
+
+
+Modify the PHP files inside the folder Application/Views/Home
+
+
+== Change the hardware ==
+
+
+Modify the PHP file Application/Include/hardware.php
+
+
+== Change the allowed distributions ==
+
+
+Modify the PHP file Application/Include/distributions.php
+
+
+== Change the allowed languages ==
+
+
+Modify the PHP file Application/Include/languages.php
+
+
+
+== Learn the EasyGiant PHP framework ==
+
+Since h-source is an application of the EasyGiant PHP framework you can use the EasyGiant features in order to modify the h-source source code. Visit www.easygiant.org
+
+
+
+