updated readme files

README.md

@@ -52,7 +52,10 @@ Issue the following command:
 ./build.sh
 ```
 
-For more detailed information, read the instructions in the folder of each module.
+For more detailed information, read the instructions in the folder of each module:
+
+* [blogracy-vuze](tree/master/blogracy-vuze)
+* [blogracy-web](tree/master/blogracy-web)
 
 ## Authors ##
 

README.md~

@@ -0,0 +1,70 @@
+# Blogracy #
+
+## Introduction ##
+
+Blogracy is a simple peer-to-peer social networking system, built on top of Bittorrent.
+
+## Install ##
+
+The installation process is not yet streamlined. Essentially Blogracy is composed
+by two main modules:
+
+1. a Vuze plugin
+2. a web application
+
+The build system uses Maven. If you have a working  maven
+installation things should be rather smooth.
+
+### Getting Blogracy ###
+
+The preferred way to obtain blogracy sources is with git. Blogracy main
+repository is hosted at git://github.com/rik0/blogracy.git. However,
+if you intend to contribute to blogracy, we strongly encourage you to make a
+fork and then pull request the modifications.
+
+#### Fork ####
+
+1. Create a fork through GitHub repository
+2. The fork repository will be at git@github.com:\<USERNAME\>/blogracy.git
+   where \<USERNAME\> is your actual username
+3. Clone the new git fork:
+
+```
+git clone git@github.com:<USERNAME>/blogracy.git
+```
+
+If you are using Eclipse, issue the command directly in the workspace or
+move the sources afterwards.
+
+#### Read-Only ####
+
+To get the sources "read only" simply:
+
+```
+git://github.com/rik0/blogracy.git
+```
+
+### Compile  and Run ###
+
+Issue the following command:
+
+```
+./build.sh
+```
+
+For more detailed information, read the instructions in the folder of each module:
+
+* blogracy-vuze
+* blogracy-web
+
+## Authors ##
+
+The code of the present versions is mostly written by Enrico Franchi and Michele Tomaiuolo.
+
+The project is currently maintained by Enrico Franchi and Michele Tomaiuolo.
+
+## Contributors ##
+
+* Enrico Franchi (efranchi@ce.unipr.it) [ core ]
+* Michele Tomaiuolo (tomamic@ce.unipr.it) [ core ]
+* Alan Nonnato () [ old core ]

blogracy-vuze/.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,6 @@
+#Mon May 21 09:46:15 CEST 2012
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
+org.eclipse.jdt.core.compiler.compliance=1.6
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.source=1.6

blogracy-vuze/.settings/org.eclipse.m2e.core.prefs

@@ -0,0 +1,5 @@
+#Mon May 21 09:46:10 CEST 2012
+activeProfiles=
+eclipse.preferences.version=1
+resolveWorkspaceProjects=true
+version=1

blogracy-vuze/README.md

@@ -15,9 +15,8 @@ This information regards the first module, the Vuze plugin.
 Vuze is not packaged for Maven right now. This may change in the future.
 Right now, it is necessary to:
 
-1. Download Vuze jar (and sources) from main Vuze site: http://dev.vuze.com/
-   A link which is working at the present time is:
-   http://sourceforge.net/projects/azureus/files/vuze/Vuze_4702/Vuze_4702.jar/download
+1. Download the latest AzureusXYZ.jar from main Vuze site: http://dev.vuze.com/
+   Rename the downloaded file to Azureus2.jar, as suggested on the Vuze site
 2. In the same directory where the files have been downloaded, execute
    the "mvn-install-vuze.sh" script.
 

blogracy-vuze/README.md~

@@ -0,0 +1,99 @@
+# Blogracy #
+
+## Introduction ##
+
+Blogracy is a simple peer-to-peer social networking system, built on top of Bittorrent.
+Essentially Blogracy is composed by two main modules:
+
+1. a Vuze plugin
+2. a web application
+
+This information regards the first module, the Vuze plugin.
+
+### Getting Vuze ###
+
+Vuze is not packaged for Maven right now. This may change in the future.
+Right now, it is necessary to:
+
+1. Download Vuze jar (and sources) from main Vuze site: http://dev.vuze.com/
+   A link which is working at the present time is:
+   http://sourceforge.net/projects/azureus/files/vuze/Vuze_4702/Vuze_4702.jar/download
+2. In the same directory where the files have been downloaded, execute
+   the "mvn-install-vuze.sh" script.
+
+### Compile ###
+
+To compile the sub-project, it is sufficient to issue
+
+```
+mvn compile
+```
+
+in the sub-project folder. This compiles all the Java sources.
+The classes, the resource files (those in src/resources) and the
+configuration files (in src/config) are copied in the "target" folder.
+
+The following command, instead, creates a JAR archive in the "target" folder,
+including Vuze classes and all other dependencies.
+
+```
+mvn package
+```
+
+### Maven and the IDE ###
+
+Maven pom files are simply a description of a project. Such description can
+be easily interpreted by an IDE and can be used to build the project.
+
+Suppose that Blogracy sources have been cloned to "~/src/blogracy/".
+The first step, in the "~/src/blogracy/blogracy-vuze/" folder, is just:
+
+```
+mvn eclipse:eclipse
+```
+
+that updates the eclipse project with stuff coming from maven.
+Repeat this step when something changes in the pom file.
+
+Then, start Eclipse using blogracy as workspace:
+
+```
+eclipse -data ~/src/blogracy/
+```
+
+In Eclipse, choose "Import Existing Maven Project" from the "File" menu, 
+and indicate the "~/src/blogracy/blogracy-vuze/" folder.
+
+Feel free to read more documentation regarding integrating Eclipse with
+Maven. There is also an excellent plugin that can be installed in Eclipse.
+We however found that this first project setup phase is easier this way.
+
+With IntelliJ things mostly work out of the box.
+
+## Run ##
+
+Either run:
+
+```
+java -jar target/blogracy-vuze-1.0-SNAPSHOT-jar-with-dependencies.jar
+```
+
+or:
+
+```
+mvn exec:exec
+```
+
+We do not use GUI or SWT. Consequently we run the Vuze console version.
+We do not depend from STW, as a consequence.
+
+Alternatively, you can put the blogracy-vuze...jar file into the plugins folder
+of Vuze, and start Vuze normally. This way, you may also need to start ActiveMQ
+by hand, separately.
+
+### Executing Blogracy inside the IDE ###
+
+Use the information above to create the appropriate configuration in the IDE.
+The Blogracy class implements a static "main" method for starting ActiveMQ,
+Vuze and Blogracy-Vuze plugin.
+

blogracy-vuze/mvn-install-vuze.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-mvn install:install-file -DgroupId=vuze -DartifactId=vuze -Dpackaging=jar -Dversion=4702 -DgeneratePom=true -Dfile=Vuze_4702.jar
+mvn install:install-file -DgroupId=vuze -DartifactId=azureus -Dpackaging=jar -Dversion=2 -DgeneratePom=true -Dfile=Azureus2.jar

blogracy-vuze/mvn-install-vuze.sh~

@@ -0,0 +1,2 @@
+#!/bin/bash
+mvn install:install-file -DgroupId=vuze -DartifactId=vuze -Dpackaging=jar -Dversion=2 -DgeneratePom=true -Dfile=Azureus2.jar

blogracy-vuze/pom.xml

@@ -91,8 +91,8 @@
     </dependency-->
     <dependency>
       <groupId>vuze</groupId>
-      <artifactId>vuze</artifactId>
-      <version>4702</version>
+      <artifactId>azureus</artifactId>
+      <version>2</version>
     </dependency>
     <dependency>
       <groupId>org.apache.activemq</groupId>

blogracy-vuze/pom.xml~

@@ -0,0 +1,108 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>net.blogracy</groupId>
+  <artifactId>blogracy-vuze</artifactId>
+  <packaging>jar</packaging>
+  <version>1.0-SNAPSHOT</version>
+  <name>blogracy-vuze</name>
+  <url>http://maven.apache.org</url>
+
+  <build>
+    <resources>
+      <resource>
+        <directory>src/main/plugins</directory>
+	<targetPath>../plugins/</targetPath>
+      </resource>
+	  <resource>
+        <directory>src/main/java/net/blogracy/chat/resources</directory>
+      </resource>
+    </resources>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>2.3.2</version>
+        <configuration>
+          <source>1.6</source>
+          <target>1.6</target>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>exec-maven-plugin</artifactId>
+        <version>1.2.1</version>
+        <configuration>
+          <executable>java</executable>
+          <workingDirectory>target/</workingDirectory>
+          <arguments>
+            <argument>-Dazureus.config.path=.</argument>
+            <argument>-classpath</argument>
+            <classpath/>
+            <argument>net.blogracy.Blogracy</argument>
+          </arguments>
+        </configuration>
+      </plugin>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>net.blogracy.Blogracy</mainClass>
+            </manifest>
+          </archive>
+          <descriptorRefs>
+            <descriptorRef>jar-with-dependencies</descriptorRef>
+          </descriptorRefs>
+          <includeProjectDependencies>true</includeProjectDependencies>
+        </configuration>
+        <executions>
+          <execution>
+            <id>make-assembly</id>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.9</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>commons-cli</groupId>
+      <artifactId>commons-cli</artifactId>
+      <version>1.2</version>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.6.4</version>
+    </dependency>
+    <!--dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>1.0.0</version>
+    </dependency-->
+    <dependency>
+      <groupId>vuze</groupId>
+      <artifactId>vuze</artifactId>
+      <version>4702</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.activemq</groupId>
+      <artifactId>activemq-core</artifactId>
+      <version>5.5.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20090211</version>
+    </dependency>
+  </dependencies>
+</project>

blogracy-web/.settings/org.eclipse.jdt.core.prefs

@@ -0,0 +1,6 @@
+#Thu May 03 23:21:54 CEST 2012
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
+org.eclipse.jdt.core.compiler.compliance=1.6
+org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
+org.eclipse.jdt.core.compiler.source=1.6

blogracy-web/.settings/org.eclipse.m2e.core.prefs

@@ -0,0 +1,5 @@
+#Thu May 03 23:21:49 CEST 2012
+activeProfiles=
+eclipse.preferences.version=1
+resolveWorkspaceProjects=true
+version=1

blogracy-web/README.md

@@ -62,6 +62,8 @@ mvn jetty:run
 
 Alternatively, you can deploy the webapp into any Java web container.
 
+Blogracy web interface is available at: htpp://localhost:8080
+
 ### Executing Blogracy inside the IDE ###
 
 Use the information above to create the appropriate configuration in the IDE.