You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@roller.apache.org by sn...@apache.org on 2017/11/06 22:17:20 UTC
[19/35] roller git commit: Convert README to markdown.
Convert README to markdown.
Project: http://git-wip-us.apache.org/repos/asf/roller/repo
Commit: http://git-wip-us.apache.org/repos/asf/roller/commit/9f2d3c18
Tree: http://git-wip-us.apache.org/repos/asf/roller/tree/9f2d3c18
Diff: http://git-wip-us.apache.org/repos/asf/roller/diff/9f2d3c18
Branch: refs/heads/master
Commit: 9f2d3c18d4214606d69884f68b5ce9fa726127ff
Parents: aef2ea2
Author: Dave Johnson <sn...@gmail.com>
Authored: Sun Oct 1 10:21:46 2017 -0400
Committer: Dave Johnson <sn...@gmail.com>
Committed: Sun Oct 1 10:21:46 2017 -0400
----------------------------------------------------------------------
README.md | 54 +++++++++++++++++++++++++++++++++++++++++++
README.txt | 49 ---------------------------------------
assembly-release/pom.xml | 2 +-
3 files changed, 55 insertions(+), 50 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/roller/blob/9f2d3c18/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0953102
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Apache Roller
+
+[Apache Roller](http://roller.apache.org) is a Java-based, full-featured,
+multi-user and group-blog server suitable for blog sites large and small.
+Roller is typically run with Apache Tomcat and MySQL.
+Roller is made up of the following Maven projects:
+
+* _roller-project_: Top level project
+* _app_: Roller Weblogger webapp, JSP pages, Velocity templates
+* _assembly-release_: Used to create official distributions of Roller
+* _docs_: Roller documentation in ODT format
+* _it-selenium_: Integrated browser tests for Roller using Selenium
+
+## Documentation
+
+The Roller Install, User and Template Guides are available in ODT format
+(for OpenOffice or LibraOffice):
+
+* https://github.com/apache/roller/tree/master/docs
+
+## For more information
+
+Hit the Roller Confluence wiki:
+
+* How to build and run Roller: https://cwiki.apache.org/confluence/x/EM4
+* How to contribute to Roller: https://cwiki.apache.org/confluence/x/2hsB
+* How to make a release of Roller: https://cwiki.apache.org/confluence/x/gycB
+* Other developer resources: https://cwiki.apache.org/confluence/x/D84
+
+## Quick start
+
+Assuming you've got a UNIX shell, Java, Maven and Git:
+
+Get the code:
+
+ $ git clone https://github.com/apache/roller.git
+
+Build and test the code:
+
+ $ cd roller
+ $ mvn clean install
+
+Run Roller in Jetty with Derby database:
+
+ $ cd app
+ $ mvn jetty:run
+
+Browse to http://localhost:8080/roller
+
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/roller/blob/9f2d3c18/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
deleted file mode 100644
index fcf2b08..0000000
--- a/README.txt
+++ /dev/null
@@ -1,49 +0,0 @@
-README.txt
-
-This file exists at the top-level of the Roller source tree.
-
-Roller is made up of the following Maven projects:
-
- roller-project: Top level project
- app: Roller Weblogger webapp, JSP pages, Velocity templates
- assembly-release: Used to create official distributions of Roller
- docs: Roller documentation in ODT (OpenOffice/LibreOffice) format
- it-selenium Integrated browser tests for Roller using Selenium
-
-To pull the latest trunk sources you need a Subversion client:
- svn co https://svn.apache.org/repos/asf/roller/trunk roller_trunk
-
-Building this version of Roller requires Apache Maven 3.0.5.
- - How to build Roller: https://cwiki.apache.org/confluence/x/EM4
- - To build and run Roller on Eclipse: https://cwiki.apache.org/confluence/x/EM4
-
-----------------------------------------------------------
-How to build the source
-
-The normal Roller build creates a product generically suitable for use several
-application containers, however see the Roller Install guide for application server
-specific configuration information.
-
-After pulling the source tree and changing directory to its top level, as
-indicated above, the following command will build and run all unit tests:
-
- mvn clean install
-
-After doing that, you should find the newly built Roller webapp, suitable
-for use in app/target/roller.
-
-To build Roller, subsequently run "mvn clean install" from the assembly-release
-folder. After that, you'll find Roller distribution files in
-assembly-release/target.
-
----------------------------
-NOTES
-
-Building other versions of Roller
-
-If you wish to pull a branch other than the trunk, replace the word
-"trunk" in both lines above with the appropriate branch name. Note that
-versions of Roller before 5.0 have an Ant-based build. In general, you should
-be able to follow instructions accompanying the sources that you pull in order
-to build that version.
-
http://git-wip-us.apache.org/repos/asf/roller/blob/9f2d3c18/assembly-release/pom.xml
----------------------------------------------------------------------
diff --git a/assembly-release/pom.xml b/assembly-release/pom.xml
index 9bb592b..77dac0d 100644
--- a/assembly-release/pom.xml
+++ b/assembly-release/pom.xml
@@ -33,7 +33,7 @@
<description>Assembles Roller into a distribution package</description>
<!--
- Check the README.txt in the Roller base folder for
+ Check the README.md in the Roller base folder for
information on creating the Roller distribution files.
-->
<build>