README
changeset 1087 c3db5e44f8f3
parent 801 eb8b23f11744
child 1273 3351055b467e
equal deleted inserted replaced
1086:6a59951b70e4 1087:c3db5e44f8f3
     1 Enano CMS
     1 Enano CMS
     2 Version 1.1.6
     2 Version 1.1.7
     3 -----------------------------
     3 -----------------------------
     4 
     4 
     5 Thanks for downloading Enano! If you're looking for an installation guide,
     5 Thanks for downloading Enano! If you're looking for an installation guide,
     6 you can find it at <http://docs.enanocms.org/Help:2.1>.
     6 you can find it at <http://docs.enanocms.org/Help:2.1>.
     7 
     7 
    42 
    42 
    43 Most of the PHP code in Enano was written by Dan Fuhry. Some parts were borrowed
    43 Most of the PHP code in Enano was written by Dan Fuhry. Some parts were borrowed
    44 from other projects that are also released under Free licenses; see the various
    44 from other projects that are also released under Free licenses; see the various
    45 files under the licenses/ directory included with this release for details.
    45 files under the licenses/ directory included with this release for details.
    46 
    46 
    47 MODIFIED DISTRIBUTIONS / FORKS
       
    48 -----------------------------
       
    49 
       
    50 Please note that the Enano team does not provide any support for modified or
       
    51 "modded" releases. So if you modify the Enano sources at all, you will not
       
    52 receive any support from official sources. If you distribute your modified
       
    53 versions, providing support is entirely up to you. You also must remove any
       
    54 links to official Enano support channels contained in the source code if you
       
    55 distribute any modified version of Enano. We also respectfully request that you
       
    56 not call any modified distributions "Enano" or any deviation thereof; while the
       
    57 term "Enano" is not a registered trademark, we do ask that you respect it.
       
    58 
       
    59 Please note that the official Enano artwork is copyrighted and not under the
       
    60 GPL. If you distribute any modified version of Enano, you must change the
       
    61 artwork. (If you're seeking to include Enano as part of a larger software
       
    62 distribution, such as GNU/Linux or BSD, e-mail Dan for special terms.)
       
    63 
       
    64 As permitted by the GPL, you may charge for the service of downloading Enano
       
    65 from your server; however, you may not prevent others from distributing Enano
       
    66 or any modified version.
       
    67 
       
    68 CHANGES IN THIS RELEASE
    47 CHANGES IN THIS RELEASE
    69 -----------------------------
    48 -----------------------------
    70 
    49 
    71 Please see <http://enanocms.org/Release_notes/1.1.5> for a list of changes in
    50 Please see <http://enanocms.org/Release_notes/1.1.7> for a list of changes in
    72 this release.
    51 this release.
    73 
    52 
    74 UPGRADING FROM PREVIOUS RELEASES
    53 UPGRADING FROM PREVIOUS RELEASES
    75 -----------------------------
    54 -----------------------------
    76 
    55 
    77 This archive includes a script that can migrate an Enano 1.0.x installation to
    56 This archive includes a script that can migrate an Enano 1.0.x installation to
    78 Enano 1.1. Before running the migration script, you should always be sure to
    57 Enano 1.2. Before running the migration script, you should always be sure to
    79 upgrade to the latest version of Enano 1.0.x (1.0.4 "Ellyyllon" at the time of
    58 upgrade to the latest version of Enano 1.0.x (1.0.7 "FIXME" at the time of
    80 this writing). Migration is NOT REVERSIBLE. This is alpha-quality code. DO NOT
    59 this writing). Migration is NOT REVERSIBLE. This is beta-quality code. DO NOT
    81 UNDER ANY CIRCUMSTANCES UPGRADE A PRODUCTION SITE.
    60 UNDER ANY CIRCUMSTANCES UPGRADE A PRODUCTION SITE.
    82 
    61 
    83 As of Enano 1.1.2, upgrades from previous 1.1.x versions are supported. The API
    62 Upgrades from any 1.1.x version are fully supported and generally more stable
    84 is considered fairly stable as of 1.1.4, but the interface is still a work in
    63 than upgrades from 1.0 because of all the API changes. If you experience
    85 progress except for the installer UI core, which is quite close to final.
    64 trouble upgrading from a 1.0 version to 1.2, try upgrading first to version
       
    65 1.1.6 or so.
    86 
    66 
    87 TRANSLATING ENANO
    67 TRANSLATING ENANO
    88 -----------------------------
    68 -----------------------------
    89 
    69 
    90 This is the only the fifth formal release of Enano that is localized. Right
    70 There have been quite a few changes to strings in the 1.2 series. Since this
    91 now since this is an alpha, you probably don't want to do any translation
    71 is a beta, you probably don't want to do a lot of translation because you'll
    92 because you'll be doing a TON more strings at every release. HOWEVER, we're
    72 be doing a TON more strings at every release. HOWEVER, we're looking for
    93 looking for people to sign up and volunteer for translation efforts later on.
    73 people to sign up and volunteer for translation efforts later on. If you have
    94 If you have a native or very good knowledge of a language, drop us an e-mail
    74 a native or very good knowledge of a language, drop us an e-mail and we'll get
    95 and we'll get you onto the translator list and eventually onto a mailing list
    75 you onto the translator list and eventually onto a mailing list specifically
    96 specifically for l10n.
    76 for l10n if that effort becomes big enough.
    97 
    77 
    98 EXPANDING YOUR SITE'S CAPABILITIES
    78 PLUG-INS
    99 -----------------------------
    79 -----------------------------
   100 
    80 
   101 There is a gallery of plugins for Enano at
    81 Most Enano features you see are actually the work of plugins. You can see a
   102 <http://enanocms.org/Category:Plugins>. It's not very full right now because
    82 gallery of plugins at <http://enanocms.org/Category:Plugins>. Most of the
   103 not every plugin has a page on the website yet, and some plugins still have
    83 plugins there work under Enano 1.2, but some don't. Plugins with known
   104 yet to be ported to work with some of the newer API changes. Being an alpha
    84 compatibility problems are marked; if you don't see any notes to the
   105 release you'll probably need to look in the Mercurial repositories at
    85 contrary, it's probably compatible with Enano 1.2.
   106 <http://hg.enanocms.org/> for the latest versions of plugins that are designed
       
   107 to work under both 1.0.x and 1.1.x.
       
   108 
    86 
   109 GIVING YOUR SITE A NEW LOOK
    87 THEMES
   110 -----------------------------
    88 -----------------------------
   111 
    89 
   112 You can find more themes for Enano at <http://enanocms.org/Category:Themes>.
    90 You can find more themes for Enano at <http://enanocms.org/Category:Themes>.
   113 Again, we're still working on packaging up themes and creating pages for them,
    91 We're not doing too great with developing themes, and what we have developed
   114 so try to be patient. We have quite a few themes in the works. You can create
    92 often doesn't make it up to the website. :) So your choices on the website
   115 your own themes too; for more information, see Chapter V of the Enano
    93 look a little bit more limited than they really are.
   116 Administrator's handbook, at <http://docs.enanocms.org/Help:5>. Unless
    94 
   117 specifically marked, themes on the Enano website are compatible with 1.0.x.
    95 Unlike plugins, themes are generally very easy to port from 1.0 to 1.2. Copy
   118 While you can use 1.0.x themes under 1.1.x, some features (namely viewing IPs
    96 over acledit.tpl, comment.tpl, and toolbar.tpl from a 1.2 theme and remove
   119 on comments and the default "Inherit" option in the ACL editor) will be missing
    97 the <script> tag that includes jsres.php, replacing it with {JS_HEADER} in
   120 unless you copy over comment.tpl and acledit.tpl respectively from Oxygen or
    98 header.tpl. Then put {JS_FOOTER} right before </body> in footer.tpl. Do the
   121 one of the other themes included with this 1.1.x package.
    99 same in simple_header.tpl and simple_footer.tpl. That's pretty much it.
   122 
   100 
   123 PLUGIN DEVELOPMENT
   101 PLUGIN DEVELOPMENT
   124 -----------------------------
   102 -----------------------------
   125 
   103 
   126 The plugin API in Enano 1.1 has been dramatically revamped from 1.0. Some
   104 The plugin API in Enano 1.1 has been dramatically revamped from 1.0. Some
   127 effort has been made to allow 1.0.x plugins that don't hook very deeply to
   105 effort has been made to allow 1.0.x plugins that don't hook very deeply to
   128 continue to work; however with all of the new functionality (localization
   106 continue to work; however with all of the new functionality (localization
   129 especially) we recommend that developers take the time to learn how to use the
   107 especially) we recommend that developers take the time to learn how to use the
   130 new plugin management platform. This system is fully documented in the large
   108 newer parts of the Enano platform. Enano tries to be very developer-friendly;
   131 comment block in plugins/admin/PluginManager.php.
   109 our full API documentation is at <http://docs.enanocms.org/API>.
   132 
   110 
   133 GETTING SUPPORT
   111 GETTING SUPPORT
   134 -----------------------------
   112 -----------------------------
   135 
   113 
   136 This is an alpha release. No support of any kind will be provided, but proper
   114 This is a beta release. No support of any kind will be provided, but proper bug
   137 bug reports are appreciated. See the Enano forums at
   115 reports are appreciated. See the Enano forums at <http://forum.enanocms.org/>
   138 <http://forum.enanocms.org/> for more information.
   116 for more information.
   139 
   117 
   140 Have fun with Enano!
   118 Have fun with Enano!
   141 
       
   142 - The Enano team
       
   143   Dan Fuhry     <dan@enanocms.org>
       
   144   Neal Gompa    <neal@enanocms.org>
       
   145   Manoj Maddali <manoj@enanocms.org>
       
   146   ThGeneral8    <the.true.general@googlemail.com>
       
   147