From: Olivier Lamy <olamy@apache.org>
Date: Thu, 27 Mar 2014 06:02:23 +0000 (+0000)
Subject: move README.txt to README.md and update it
X-Git-Tag: archiva-2.1.0~156
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=1011a321c84ab48353a12fa809297f5879358ade;p=archiva.git

move README.txt to README.md and update it

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1582202 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..73c9ec88b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+Apache Archiva
+==============
+
+To get involved in Archiva development, contact dev@archiva.apache.org.
+
+NOTE: you will need a MAVEN_OPTS with some memory setup as sample :
+export MAVEN_OPTS="-Xmx768m -Xms768m -XX:MaxPermSize=256m"
+
+Running from Source Code
+========================
+
+As webapp js is in dev and won't probably be released soon, the module is not activated by default and it's included only in a profile
+mvn tomcat7:run -pl :archiva-webapp -am  (to save fingers :-) use sh ./t7.sh ) (debug with sh ./t7-debug.sh  port 8000)
+
+
+hit your browser: http://localhost:9091/archiva/index.html
+
+Test Registration email
+========================
+Redback can send email on registration by default the mail jndi si configured to use localhost.
+You can use your gmail accout for testing purpose
+In your ~/.m2/settings.xml add a property with a path to a tomcat context file:
+<tomcatContextXml>/Users/olamy/dev/tomcat-context-archiva-gmail.xml</tomcatContextXml>
+
+This file must contains:
+
+<Context path="/archiva">
+  <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"
+            username="sa"
+            password=""
+            driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
+            url="jdbc:derby:${catalina.base}/target/database/users;create=true"
+  />
+  <Resource name="mail/Session" auth="Container"
+          type="javax.mail.Session"
+          mail.smtp.host="smtp.gmail.com"
+          mail.smtp.port="465"
+          mail.smtp.auth="true"
+          mail.smtp.user="your gmail account"
+          password="your gmail password"
+          mail.smtp.starttls.enable="true"
+          mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"/>
+
+</Context>
+
+Using with cassandra as metadata storage
+========================
+You can run the application using cassandra as storage.
+sh ./t7.sh -Pcassandra
+
+Default cassandra host is localhost and port 9160
+
+You can override using:
+
+ * -Dcassandra.host=
+ * -Dcassandra.port=
+
+
+
+
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 220bcb58d..000000000
--- a/README.txt
+++ /dev/null
@@ -1,49 +0,0 @@
-Apache Archiva
-==============
-
-To get involved in Archiva development, contact dev@archiva.apache.org.
-
-NOTE: you will need a MAVEN_OPTS with some memory setup as sample :
-export MAVEN_OPTS="-Xmx768m -Xms768m -XX:MaxPermSize=256m"
-
-Running from Source Code
-========================
-
-As webapp js is in dev and won't probably be released soon, the module is not activated by default and it's included only in a profile
-mvn tomcat7:run -pl :archiva-webapp -am  (to save fingers :-) use sh ./t7.sh )
-or
-mvn tomcat6:run -pl :archiva-webapp -am
-
-hit your browser: http://localhost:9091/archiva/index.html
-
-Test Registration email
-========================
-Redback can send email on registration by default the mail jndi si configured to use localhost.
-You can use your gmail accout for testing purpose
-In your ~/.m2/settings.xml add a property with a path to a tomcat context file:
-<tomcatContextXml>/Users/olamy/dev/tomcat-context-archiva-gmail.xml</tomcatContextXml>
-
-This file must contains:
-
-<Context path="/archiva">
-  <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource"
-            username="sa"
-            password=""
-            driverClassName="org.apache.derby.jdbc.EmbeddedDriver"
-            url="jdbc:derby:${catalina.base}/target/database/users;create=true"
-  />
-  <Resource name="mail/Session" auth="Container"
-          type="javax.mail.Session"
-          mail.smtp.host="smtp.gmail.com"
-          mail.smtp.port="465"
-          mail.smtp.auth="true"
-          mail.smtp.user="your gmail account"
-          password="your gmail password"
-          mail.smtp.starttls.enable="true"
-          mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"/>
-
-</Context>
-
-jrebel
-generate files:  mvn org.zeroturnaround:jrebel-maven-plugin:1.1.3:generate -Pjs
-