Hi All, please review my proposal for some modifications to the README file of the trunk; for your easy reference I have included below: [*] this is the whole README file [**] this is the diff file
I have tried to simplify it and make it more consistent with the new layout of the OFBiz site. If we will commit this new version of the README file I would like to use its last part also for the file in the upcoming 12.04.01 release. Please let me know what you think. Thanks, Jacopo ----------------------------------------------------------------------------------------------------------------------------------------- [*] Welcome to Apache OFBiz! All you need to run OFBiz is a 1.6 (version 6) JDK (not just the JRE, the full JDK). http://java.sun.com/javase/downloads/index.jsp You can load the demo data (strongly advised if you are new to OFBiz) with the following command on the command line from the OFBiz home folder (in Unix-like operating systems type "./ant" rather than "ant"): ant load-demo Then start OFBiz with the following command: ant start (or "java -Xms128M -Xmx512M -XX:MaxPermSize=128m -jar ofbiz.jar") Once OFBiz starts, you can look at the demo storefront at: http://localhost:8080/ecommerce and the administration interface at: https://localhost:8443/webtools You can log in with the user "admin" and password "ofbiz". You can stop OFBiz with the command: ant stop You will also find several platform dependent scripts in the "tools" folder (for example for Windows and Unix-like operating systems, the startup scripts are startofbiz.bat and startofbiz.sh). Note that running with the default configuration uses an embedded Java database (Apache Derby), and embedded application server components such as Tomcat, Geronimo (transaction manager), etc. For more details about OFBiz please visit the OFBiz Documentation page: http://ofbiz.apache.org/documentation.html In this page you will find links to useful guides like: * "Demo and Test Setup Guide" * "Basic Production Setup Guide" * "A Beginners Development Guide" If you would like to get in touch with the OFBiz community of users and developers, the following page will help to get started: http://ofbiz.apache.org/community.html Enjoy! ----------------------------------------------------------------------------------------------------------------------------------------- [**] Index: README =================================================================== --- README (revision 1460124) +++ README (working copy) @@ -5,9 +5,10 @@ (not just the JRE, the full JDK). http://java.sun.com/javase/downloads/index.jsp -You can load the demo data (strongly advised) with the following -command on the command line from the OFBiz home folder (in Unix-like -operating systems type "./ant" rather than "ant"): +You can load the demo data (strongly advised if you are new to +OFBiz) with the following command on the command line +from the OFBiz home folder (in Unix-like operating systems +type "./ant" rather than "ant"): ant load-demo @@ -33,26 +34,23 @@ "tools" folder (for example for Windows and Unix-like operating systems, the startup scripts are startofbiz.bat and startofbiz.sh). -For more details about running a build, or for information on -getting, building, and running the source please see the -Apache OFBiz Setup Guide: - -http://cwiki.apache.org/confluence/display/OFBADMIN/Demo+and+Test+Setup+Guide - Note that running with the default configuration uses an embedded Java database (Apache Derby), and embedded application server components such as Tomcat, Geronimo (transaction manager), etc. -To prepare OFBiz for production use the Basic Production Setup Guide -is a great place to start. It is available here: +For more details about OFBiz please visit the OFBiz Documentation page: -http://cwiki.apache.org/confluence/display/OFBTECH/Apache+OFBiz+Technical+Production+Setup+Guide +http://ofbiz.apache.org/documentation.html -Are you newbie for Apache OFBiz project? Are you confused how to start development? Please refer the beginner guide available at: +In this page you will find links to useful guides like: +* "Demo and Test Setup Guide" +* "Basic Production Setup Guide" +* "A Beginners Development Guide" -https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Tutorial+-+A+Beginners+Development+Guide +If you would like to get in touch with the OFBiz community of users and +developers, the following page will help to get started: -For additional resources please see the OFBiz web site. +http://ofbiz.apache.org/community.html Enjoy!