WordPress.org

Make WordPress Core

Changeset 13516


Ignore:
Timestamp:
02/28/10 22:38:56 (4 years ago)
Author:
nacin
Message:

First pass on readme.html updates. Include references to the automatic upgrader, the wp-config.php creation script, the new user/pass selection during install. Split system recommendations into requirements and recommendations. Style dt/dl/dd elements. Remove archaic v1.2 to 1.5 theme template reference. Change wording in post via mail and user roles, as neither are new features. Props niallkennedy for minor cleanups in the commit. see #10835

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/readme.html

    r12458 r13516  
    33<head> 
    44    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    5     <title>WordPress &rsaquo; ReadMe</title> 
    6     <link rel="stylesheet" href="wp-admin/css/install.css" type="text/css" /> 
     5    <title>WordPress &#8250; ReadMe</title> 
     6    <link rel="stylesheet" href="wp-admin/css/install.dev.css" type="text/css" /> 
    77</head> 
    88<body> 
    9 <h1 id="logo" style="text-align: center"> 
    10     <img alt="WordPress" src="wp-admin/images/wordpress-logo.png" /> 
     9<h1 id="logo"> 
     10    <a href="http://wordpress.org/"><img alt="WordPress" src="wp-admin/images/wordpress-logo.png" width="250" height="68" /></a> 
    1111    <br /> Version 3.0 
    1212</h1> 
     
    1515<h1>First Things First</h1> 
    1616<p>Welcome. WordPress is a very special project to me. Every developer and contributor adds something unique to the mix, and together we create something beautiful that I'm proud to be a part of. Thousands of hours have gone into WordPress, and we're dedicated to making it better every day. Thank you for making it part of your world.</p> 
    17 <p style="text-align: right;">&#8212; Matt Mullenweg</p> 
     17<p style="text-align: right">&#8212; Matt Mullenweg</p> 
    1818 
    1919<h1>Installation: Famous 5-minute install</h1> 
    2020<ol> 
    21     <li>Unzip the package in an empty directory.</li> 
    22     <li>Open up <code>wp-config-sample.php</code> with a text editor like WordPad or similar and fill in your database connection details.</li> 
    23     <li>Save the file as <code>wp-config.php</code></li> 
    24     <li>Upload everything.</li> 
    25     <li>Open <span class="file"><a href="wp-admin/install.php">/wp-admin/install.php</a></span> in your browser. This should setup the tables needed for your blog. If there is an error, double check your <span class="file">wp-config.php</span> file, and try again. If it fails again, please go to the <a href="http://wordpress.org/support/">support forums</a> with as much data as you can gather.</li> 
    26     <li><strong>Note the password given to you.</strong></li> 
    27     <li> The install script should then send you to the <a href="wp-login.php">login page</a>. Sign in with the username <code>admin</code> and the password generated during the installation. You can then click on 'Profile' to change the password.</li> 
     21    <li>Unzip the package in an empty directory and upload everything.</li> 
     22    <li>Open <span class="file"><a href="wp-admin/install.php">wp-admin/install.php</a></span> in your browser. It will take you through the process to set up a <code>wp-config.php</code> file with your database connection details. 
     23        <ol> 
     24            <li>If for some reason this doesn't work, don't worry. It doesn't work on all web hosts. Open up <code>wp-config-sample.php</code> with a text editor like WordPad or similar and fill in your database connection details.</li> 
     25            <li>Save the file as <code>wp-config.php</code> and upload it.</li> 
     26            <li>Open <span class="file"><a href="wp-admin/install.php">wp-admin/install.php</a></span> in your browser.</li> 
     27        </ol> 
     28    </li> 
     29    <li>Once the configuration file is set up, the installer will set up the tables needed for your blog. If there is an error, double check your <code>wp-config.php</code> file, and try again. If it fails again, please go to the <a href="http://wordpress.org/support/" title="WordPress support">support forums</a> with as much data as you can gather.</li> 
     30    <li><strong>If you did not enter a password, note the password given to you.</strong> If you did not provide a username, it will be <code>admin</code>.</li> 
     31    <li>The installer should then send you to the <a href="wp-login.php">login page</a>. Sign in with the username and password you chose during the installation. If a password was generated for you, you can then click on 'Profile' to change the password.</li> 
    2832</ol> 
    2933 
    3034<h1>Upgrading</h1> 
    31 <p>Before you upgrade anything, make sure you have backup copies of any files you may have modified such as <code>index.php</code>.</p> 
    32 <h2>Upgrading from any previous WordPress to 3.0:</h2> 
     35<h2>Using the Automatic Upgrader</h2> 
     36<p>If you are upgrading from version 2.7 or higher, you can use the automatic upgrader:</p> 
    3337<ol> 
    34     <li>Delete your old WP files, saving ones you've modified.</li> 
     38    <li>Open the <span class="file"><a href="wp-admin/update-core.php">wp-admin/update-core.php</a></span> in your browser and follow the instructions.</li> 
     39    <li>You wanted more, perhaps? That's it!</li> 
     40</ol> 
     41 
     42<h2>Upgrading Manually</h2> 
     43<ol> 
     44    <li>Before you upgrade anything, make sure you have backup copies of any files you may have modified such as <code>index.php</code>.</li> 
     45    <li>Delete your old WordPress files, saving ones you've modified.</li> 
    3546    <li>Upload the new files.</li> 
    3647    <li>Point your browser to <span class="file"><a href="wp-admin/upgrade.php">/wp-admin/upgrade.php</a>.</span></li> 
    37     <li>You wanted more, perhaps? That's it!</li> 
    3848</ol> 
    39 <h2>Template Changes</h2> 
    40 <p>If you have customized your templates you will probably have to make some changes to them. If you're converting your 1.2 or earlier templates, <a href="http://codex.wordpress.org/Upgrade_1.2_to_1.5">we've created a special guide for you</a>. </p> 
     49 
     50<h2>Theme Template Changes</h2> 
     51<p>If you have customized your theme templates, you may have to make some changes across major versions.</p> 
    4152 
    4253<h1>Online Resources</h1> 
    4354<p>If you have any questions that aren't addressed in this document, please take advantage of WordPress' numerous online resources:</p> 
    4455<dl> 
    45     <dt><a href="http://codex.wordpress.org/">The WordPress Codex </a></dt> 
     56    <dt><a href="http://codex.wordpress.org/">The WordPress Codex</a></dt> 
    4657        <dd>The Codex is the encyclopedia of all things WordPress. It is the most comprehensive source of information for WordPress available.</dd> 
    4758    <dt><a href="http://wordpress.org/development/">The Development Blog</a></dt> 
    48         <dd>This is where you'll find the latest updates and news related to WordPress. Bookmark and check often.</dd> 
    49     <dt><a href="http://planet.wordpress.org/">WordPress Planet </a></dt> 
     59        <dd>This is where you'll find the latest updates and news related to WordPress. Recent WordPress development news appears in your administrative dashboard by default.</dd> 
     60    <dt><a href="http://planet.wordpress.org/">WordPress Planet</a></dt> 
    5061        <dd>The WordPress Planet is a news aggregator that brings together posts from WordPress blogs around the web.</dd> 
    5162    <dt><a href="http://wordpress.org/support/">WordPress Support Forums</a></dt> 
    5263        <dd>If you've looked everywhere and still can't find an answer, the support forums are very active and have a large community ready to help. To help them help you be sure to use a descriptive thread title and describe your question in as much detail as possible.</dd> 
    53     <dt><a href="http://codex.wordpress.org/IRC">WordPress IRC Channel</a></dt> 
    54         <dd>Finally, there is an online chat channel that is used for discussion among people who use WordPress and occasionally support topics. The above wiki page should point you in the right direction. (<a href="irc://irc.freenode.net/wordpress">irc.freenode.net #wordpress</a>)</dd> 
     64    <dt><a href="http://codex.wordpress.org/IRC">WordPress <abbr title="Internet Relay Chat">IRC</abbr> Channel</a></dt> 
     65        <dd>There is an online chat channel that is used for discussion among people who use WordPress and occasionally support topics. The above wiki page should point you in the right direction. (<a href="irc://irc.freenode.net/wordpress">irc.freenode.net #wordpress</a>)</dd> 
    5566</dl> 
    5667 
    57 <h1>System Recommendations</h1> 
     68<h1>System Requirements</h1> 
    5869<ul> 
    59     <li>PHP version <strong>4.3</strong> or higher.</li> 
    60     <li>MySQL version <strong>4.1.2</strong> or higher.</li> 
    61     <li>... and a link to <a href="http://wordpress.org/">http://wordpress.org</a> on your site.</li> 
     70    <li><a href="http://php.net/">PHP</a> version <strong>4.3</strong> or higher.</li> 
     71    <li><a href="http://www.mysql.com/">MySQL</a> version <strong>4.1.2</strong> or higher.</li> 
    6272</ul> 
    63 <p>WordPress is the official continuation of <a href="http://cafelog.com/">b2/caf&eacute;log</a>, which came from Michel V. The work has been continued by the <a href="http://wordpress.org/about/">WordPress developers</a>. If you would like to support WordPress, please consider <a href="http://wordpress.org/donate/">donating</a>.</p> 
    6473 
    65 <h1>Upgrading from another system</h1> 
    66 <p>WordPress can <a href="http://codex.wordpress.org/Importing_Content">import from a number of systems</a>. First you need to get WordPress installed and working as described above.</p> 
     74<h2>System Recommendations</h2> 
     75<ul> 
     76    <li>The <a href="http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html">mod_rewrite</a> Apache module.</li> 
     77    <li>A link to <a href="http://wordpress.org/">http://wordpress.org</a> on your site.</li> 
     78</ul> 
    6779 
    68 <h1>XML-RPC and Atom Interface</h1> 
    69 <p>You can now post to your WordPress blog with tools like <a href="http://windowslivewriter.spaces.live.com/">Windows Live Writer</a>, <a href="http://ecto.kung-foo.tv/">Ecto</a>, <a href="http://bloggar.com/">Bloggar</a>, <a href="http://radio.userland.com">Radio Userland</a> (which means you can use Radio's email-to-blog feature), <a href="http://www.newzcrawler.com/">NewzCrawler</a>, and other tools that support the Blogging APIs! :) You can read more about <a href="http://codex.wordpress.org/XML-RPC_Support">XML-RPC support on the Codex</a>.</p> 
     80<h1>Migrating from other systems</h1> 
     81<p>WordPress can <a href="http://codex.wordpress.org/Importing_Content">import from a number of systems</a>. First you need to get WordPress installed and working as described above, before using <a href="wp-admin/import.php" title="Import to WordPress">our import tools</a>.</p> 
     82 
     83<h1><abbr title="eXtensible Markup Language">XML</abbr>-<abbr title="Remote Procedure Call">RPC</abbr> and Atom Interface</h1> 
     84<p>You can post to your WordPress blog with tools like <a href="http://download.live.com/writer">Windows Live Writer</a>, <a href="http://illuminex.com/ecto/">Ecto</a>, <a href="http://bloggar.com/">w.bloggar</a>, <a href="http://radio.userland.com/">Radio Userland</a> (which means you can use Radio's email-to-blog feature), <a href="http://www.newzcrawler.com/">NewzCrawler</a>, and other tools that support the blogging <abbr title="application programming interface">API</abbr>s! :) You can read more about <a href="http://codex.wordpress.org/XML-RPC_Support"><abbr>XML</abbr>-<abbr>RPC</abbr> support on the Codex</a>.</p> 
    7085 
    7186<h1>Post via Email</h1> 
    72 <p>You can post from an email client! To set this up go to your &quot;Writing&quot; options screen and fill in the connection details for your secret POP3 account. Then you need to set up <code>wp-mail.php</code> to execute periodically to check the mailbox for new posts. You can do it with Cron-jobs, or if your host doesn't support it you can look into the various website-monitoring services, and make them check your <code>wp-mail.php</code> URL.</p> 
     87<p>You can post from an email client! To set this up go to your &quot;Writing&quot; options screen and fill in the connection details for your secret <abbr title="Post Office Protocol version 3">POP3</abbr> account. Then you need to set up <code>wp-mail.php</code> to execute periodically to check the mailbox for new posts. You can do it with <a href="http://en.wikipedia.org/wiki/Cron">cron</a>-jobs, or if your host doesn't support it you can look into the various website-monitoring services, and make them check your <code>wp-mail.php</code> <abbr title="Uniform Resource Locator">URL</abbr>.</p> 
    7388<p>Posting is easy: Any email sent to the address you specify will be posted, with the subject as the title. It is best to keep the address discrete. The script will <em>delete</em> emails that are successfully posted.</p> 
    7489 
    7590<h1>User Roles</h1> 
    76 <p>We've eliminated user levels in order to make way for the much more flexible roles system introduced in 2.0. You can <a href="http://codex.wordpress.org/Roles_and_Capabilities">read more about Roles and Capabilities on the Codex</a>.</p> 
     91<p>We introduced a very flexible roles system in version 2.0, eliminating user levels. You can <a href="http://codex.wordpress.org/Roles_and_Capabilities" title="WordPress roles and capabilities">read more about Roles and Capabilities on the Codex</a>.</p> 
    7792 
    78 <h1> Final notes</h1> 
     93<h1>Final notes</h1> 
    7994<ul> 
    80     <li>If you have any suggestions, ideas, comments, or if you (gasp!) found a bug, join us in the <a href="http://wordpress.org/support/">Support Forums</a>.</li> 
    81     <li>WordPress now has a robust plugin API that makes extending the code easy. If you are a developer interested in utilizing this see the <a href="http://codex.wordpress.org/Plugin_API">plugin documentation in the Codex</a>. In most all cases you shouldn't modify any of the core code.</li> 
     95    <li>If you have any suggestions, ideas, or comments, or if you (gasp!) found a bug, join us in the <a href="http://wordpress.org/support/">Support Forums</a>.</li> 
     96    <li>WordPress now has a robust plugin <abbr title="application programming interface">API</abbr> that makes extending the code easy. If you are a developer interested in utilizing this, see the <a href="http://codex.wordpress.org/Plugin_API" title="WordPress plugin API">plugin documentation in the Codex</a>. In most all cases you shouldn't modify any of the core code.</li> 
    8297</ul> 
    8398 
     
    85100<p>WordPress has no multi-million dollar marketing campaign or celebrity sponsors, but we do have something even better&#8212;you. If you enjoy WordPress please consider telling a friend, setting it up for someone less knowledgable than yourself, or writing the author of a media article that overlooks us.</p> 
    86101 
     102<p>WordPress is the official continuation of <a href="http://cafelog.com/">b2/caf&#233;log</a>, which came from Michel V. The work has been continued by the <a href="http://wordpress.org/about/">WordPress developers</a>. If you would like to support WordPress, please consider <a href="http://wordpress.org/donate/" title="Donate to WordPress">donating</a>.</p> 
     103 
    87104<h1>Copyright</h1> 
    88 <p>WordPress is released under the <abbr title="GNU Public License">GPL</abbr> (see <a href="license.txt">license.txt</a>).</p> 
     105<p>WordPress is released under the <abbr title="GNU Public License">GPL</abbr>v2 (see <a href="license.txt">license.txt</a>).</p> 
     106 
    89107 
    90108</body> 
Note: See TracChangeset for help on using the changeset viewer.