mirror of
https://github.com/processwire/processwire.git
synced 2025-08-07 15:26:54 +02:00
README file updates for new master version
This commit is contained in:
@@ -410,7 +410,7 @@ https://processwire.com/about/license/mit/
|
|||||||
|
|
||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2018 Ryan Cramer <or other year/person if indicated in file>
|
Copyright (c) 2020 Ryan Cramer <or other year/person if indicated in file>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
157
README.md
157
README.md
@@ -9,54 +9,139 @@ can be read at: https://github.com/processwire/processwire/blob/master/README.md
|
|||||||
1. [About](#about-processwire)
|
1. [About](#about-processwire)
|
||||||
2. [Installation](#installing-processwire)
|
2. [Installation](#installing-processwire)
|
||||||
3. [Upgrading](#upgrading-processwire)
|
3. [Upgrading](#upgrading-processwire)
|
||||||
4. [Troubleshooting](https://processwire.com/docs/install/troubleshooting/)
|
4. [Troubleshooting](https://processwire.com/docs/start/install/troubleshooting/)
|
||||||
5. [Support](#support-and-links)
|
5. [Support](#support-and-links)
|
||||||
|
|
||||||
|
|
||||||
## About ProcessWire
|
## About ProcessWire
|
||||||
|
|
||||||
ProcessWire is an open source content management system (CMS) and web
|
ProcessWire is a friendly and powerful open source CMS with an API that is a
|
||||||
application framework aimed at the needs of designers, developers and their
|
joy to use at any scale. It is both a content management system (CMS) and
|
||||||
clients. ProcessWire gives you more control over your fields, templates and
|
framework (CMF) built to save you time and work the way you do. With all custom
|
||||||
markup than other platforms, and provides a powerful template system that
|
fields, a secure foundation, proven scalability and performance, ProcessWire
|
||||||
works the way you do. Not to mention, ProcessWire's API makes working with
|
connects all of your content seamlessly, making your job fast, easy and fun.
|
||||||
your content easy and enjoyable. Managing and developing a site in
|
|
||||||
ProcessWire is shockingly simple compared to what you may be used to.
|
|
||||||
|
|
||||||
* [ProcessWire Home](https://processwire.com)
|
ProcessWire gives you more control over your fields, templates and markup than
|
||||||
* [API Reference](https://processwire.com/api/ref/)
|
other platforms, while ProcessWire’s API makes working with your content easy and
|
||||||
* [Download](https://processwire.com/download/)
|
enjoyable. Managing and developing a site in ProcessWire is shockingly simple
|
||||||
* [Support](https://processwire.com/talk/)
|
compared to what you may be used to.
|
||||||
* [Modules/Plugins](http://modules.processwire.com)
|
|
||||||
|
|
||||||
|
ProcessWire is widely trusted by web professionals for its exceptional consistency,
|
||||||
|
stability and security; revered by web developers for its API that saves time and
|
||||||
|
makes work fun; valued by web designers for its adaptability and flexibility with
|
||||||
|
modern website/application content management needs; and loved by clients for its
|
||||||
|
no-nonsense interface and ease-of-use in adding, updating and maintaining content.
|
||||||
|
New versions of ProcessWire are released just about every week on the
|
||||||
|
development branch.
|
||||||
|
|
||||||
|
|
||||||
|
### Background
|
||||||
|
|
||||||
|
ProcessWire is a timeless tool for web professionals that has always been
|
||||||
|
committed to the long term. It started in 2003, gained the name ProcessWire
|
||||||
|
in 2006, and has been in active development as an open source project since 2010.
|
||||||
|
Now more than a decade later (2020), we're just getting started, as ProcessWire
|
||||||
|
continues to grow and develop into the next 10 years and beyond.
|
||||||
|
|
||||||
|
While ProcessWire has been around for a long time, don’t feel bad if you haven’t
|
||||||
|
heard of it till today. We are fundamentally different from other projects in
|
||||||
|
that we don’t make a lot of noise, we’re not into promotion, we value quality
|
||||||
|
over quantity, sustainability over growth, and a friendly community over
|
||||||
|
popularity. ProcessWire is designed to be a silent partner, not easily
|
||||||
|
identified from the front-end of any website. We don’t aim to be big, we are
|
||||||
|
instead focused on being best-in-class.
|
||||||
|
|
||||||
|
Web developers find ProcessWire when the time is right, after they’ve tried
|
||||||
|
some other platforms. And once they start using ProcessWire, they tend to
|
||||||
|
stay—ProcessWire is addictive, easy to maintain for the long term, and doesn’t
|
||||||
|
have the security and upgrade woes of other platforms. But don’t take our word
|
||||||
|
for it; unless your livelihood depends on some other platform, find out for
|
||||||
|
yourself.
|
||||||
|
|
||||||
|
|
||||||
|
### Community
|
||||||
|
|
||||||
|
ProcessWire is more than just software, it is also a friendly community
|
||||||
|
of web professionals dedicated to building great sites and applications, and
|
||||||
|
helping others do so too. Please visit and join our
|
||||||
|
[friendly community](https://processwire.com/talk/)
|
||||||
|
in the ProcessWire forums, subscribe to our
|
||||||
|
[weekly newsletter](https://processwire.com/community/newsletter/subscribe/)
|
||||||
|
for the latest ProcessWire news, check out our
|
||||||
|
[website showcase](https://processwire.com/sites/)
|
||||||
|
to see what others are building with ProcessWire, and read our
|
||||||
|
[blog](https://processwire.com/blog/)
|
||||||
|
to stay up-to-date with the latest ProcessWire versions.
|
||||||
|
|
||||||
|
|
||||||
|
### Learn more
|
||||||
|
|
||||||
|
* [ProcessWire website](https://processwire.com)
|
||||||
|
* [About ProcessWire](https://processwire.com/about/)
|
||||||
|
* [Support forums](https://processwire.com/talk/)
|
||||||
|
* [Documentation](https://processwire.com/docs/)
|
||||||
|
* [API reference](https://processwire.com/api/ref/)
|
||||||
|
* [Downloads](https://processwire.com/download/)
|
||||||
|
* [Modules/plugins](https://modules.processwire.com)
|
||||||
|
* [Showcase](https://processwire.com/sites/)
|
||||||
|
|
||||||
|
-----------------------------------------------------------------
|
||||||
|
|
||||||
## Installing ProcessWire
|
## Installing ProcessWire
|
||||||
|
|
||||||
Simply extract the ProcessWire files to an http accessible location and
|
Simply extract the ProcessWire files to an http accessible location and
|
||||||
load the URL in your web browser. This will start the installer. See our
|
load the URL in your web browser. This will start the installer. See our
|
||||||
[Installation Guide](https://processwire.com/docs/install/new/) for more
|
[Installation Guide](https://processwire.com/docs/start/install/new/) for more
|
||||||
details and instructions. If you run into any trouble, please see our
|
details and instructions. If you run into any trouble, please see our
|
||||||
[Troubleshooting Guide](https://processwire.com/docs/install/troubleshooting/).
|
[Troubleshooting Guide](https://processwire.com/docs/start/install/troubleshooting/).
|
||||||
|
|
||||||
|
|
||||||
## Upgrading ProcessWire
|
## Upgrading ProcessWire
|
||||||
|
|
||||||
Before proceeding with any version upgrade, please read the
|
Before proceeding with any version upgrade, please see the
|
||||||
[Upgrading ProcessWire](https://processwire.com/docs/install/upgrade/)
|
[Upgrading ProcessWire](https://processwire.com/docs/start/install/upgrade/)
|
||||||
guide and keep it open during your upgrade in case you need to refer back to it.
|
guide and keep it open during your upgrade in case you need to refer back to it.
|
||||||
|
|
||||||
If upgrading from one 3.x version to another, please use the
|
|
||||||
[General Upgrade Process](https://processwire.com/docs/install/upgrade/#general-upgrade-process).
|
### Upgrading from ProcessWire 3.x (earlier version)
|
||||||
Chances are that you can upgrade simply by replacing the /wire/ directory.
|
|
||||||
|
When upgrading from one 3.x version to another, please use the
|
||||||
|
[General Upgrade Process](https://processwire.com/docs/start/install/upgrade/#general-upgrade-process).
|
||||||
|
This consists primarily of making sure you've got everything backed up and then
|
||||||
|
just replacing your `/wire/` directory with the one from the newest version.
|
||||||
|
|
||||||
|
In addition, if you are currently running any 3.x version prior to 3.0.135,
|
||||||
|
you will also want to upgrade your root `.htaccess` file to the newest version:
|
||||||
|
|
||||||
|
#### Upgrading your .htaccess file
|
||||||
|
|
||||||
|
* If you haven't made any custom modifications to your .htaccess file then you
|
||||||
|
can simply replace the old one with the new one. The new one is in a file
|
||||||
|
named `htaccess.txt` so you'll rename it to `.htaccess` after removing
|
||||||
|
your old one (all in the same directory as this README file).
|
||||||
|
|
||||||
|
* If your .htaccess file does have custom modifications, you know what they
|
||||||
|
are, and are comfortable applying them to the new one — go ahead and
|
||||||
|
follow the step above and then make those same modifications to the new
|
||||||
|
.htaccess file.
|
||||||
|
|
||||||
|
* If you aren't sure what custom modifications your .htaccess file might
|
||||||
|
have, or how to apply them to the new one, please see this post which will
|
||||||
|
quickly guide you through it:
|
||||||
|
[How to upgrade an existing .htaccess file](https://processwire.com/blog/posts/pw-3.0.135/#how-to-update-an-existing-htaccess-file)
|
||||||
|
|
||||||
|
*If you are curious what's new in this latest .htaccess file version,
|
||||||
|
please see [this post](https://processwire.com/blog/posts/pw-3.0.135/)
|
||||||
|
for all the details.*
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Upgrading from ProcessWire 2.x
|
### Upgrading from ProcessWire 2.x
|
||||||
|
|
||||||
If upgrading from ProcessWire 2.5 or older, we recommend that you upgrade
|
If upgrading from ProcessWire 2.5 or older, we recommend that you upgrade
|
||||||
to ProcessWire [2.8](https://github.com/processwire/processwire-legacy) or
|
to ProcessWire [2.7](https://github.com/ryancramerdesign/processwire) first.
|
||||||
[2.7](https://github.com/ryancramerdesign/processwire) first. Both of those
|
This version includes details in the README file on how to upgrade from that
|
||||||
versions include details in the README file on how to upgrade from these
|
older version of ProcessWire. To upgrade from ProcessWire 2.6 (or newer)
|
||||||
older versions of ProcessWire. To upgrade from ProcessWire 2.6 (or newer)
|
|
||||||
to ProcessWire 3.x, please follow the instructions below.
|
to ProcessWire 3.x, please follow the instructions below.
|
||||||
|
|
||||||
1. Login to the admin of your site.
|
1. Login to the admin of your site.
|
||||||
@@ -85,19 +170,19 @@ to ProcessWire 3.x, please follow the instructions below.
|
|||||||
`$config->debug` setting back to `false` in your /site/config.php file.
|
`$config->debug` setting back to `false` in your /site/config.php file.
|
||||||
|
|
||||||
**Troubleshooting a 3.x upgrade**
|
**Troubleshooting a 3.x upgrade**
|
||||||
If you run into any trouble upgrading, please see our troubleshooting guide
|
If you run into any trouble upgrading, please see our
|
||||||
located at <https://processwire.com/download/troubleshooting/#upgrades>.
|
[troubleshooting upgrades guide](https://processwire.com/docs/start/install/troubleshooting/#troubleshooting-upgrades).
|
||||||
|
|
||||||
|
|
||||||
### Pro module upgrade notes
|
### Pro module upgrade notes
|
||||||
|
|
||||||
- If using [FormBuilder](https://processwire.com/api/modules/form-builder/),
|
- If using [FormBuilder](https://processwire.com/store/form-builder/),
|
||||||
we recommend using only v0.3.0 or newer.
|
we recommend using only v0.3.0 or newer, but v0.4.0 or newer if possible.
|
||||||
- If using [ProCache](https://processwire.com/api/modules/procache/),
|
- If using [ProCache](https://processwire.com/store/pro-cache/),
|
||||||
we recommend using only v3.1.4 or newer.
|
we recommend using only v3.1.4 or newer.
|
||||||
- If using [ListerPro](https://processwire.com/api/modules/lister-pro/),
|
- If using [ListerPro](https://processwire.com/store/lister-pro/),
|
||||||
we recommend using only v1.0.9 or newer.
|
we recommend using only v1.0.9 or newer.
|
||||||
- If using [ProFields](https://processwire.com/api/modules/profields/),
|
- If using [ProFields](https://processwire.com/store/pro-fields/),
|
||||||
we recommend grabbing the latest versions in the ProFields support board.
|
we recommend grabbing the latest versions in the ProFields support board.
|
||||||
- If using ProCache and you upgraded your .htaccess file, you should
|
- If using ProCache and you upgraded your .htaccess file, you should
|
||||||
go to your ProCache settings after the upgrade to have it update
|
go to your ProCache settings after the upgrade to have it update
|
||||||
@@ -131,14 +216,16 @@ resolved any issues.
|
|||||||
|
|
||||||
## Support and Links
|
## Support and Links
|
||||||
|
|
||||||
* [ProcessWire Support](https://processwire.com/talk/)
|
* [ProcessWire Support Forums](https://processwire.com/talk/)
|
||||||
* [ProcessWire Weekly](https://weekly.pw/)
|
* [ProcessWire Weekly News](https://weekly.pw/)
|
||||||
* [ProcessWire Blog](https://processwire.com/blog/)
|
* [ProcessWire Blog](https://processwire.com/blog/)
|
||||||
|
* [Sites running ProcessWire](https://processwire.com/sites/)
|
||||||
|
* [Subscribe to ProcessWire Weekly email](https://processwire.com/community/newsletter/subscribe/)
|
||||||
|
* [Submit your site to our directory](https://processwire.com/sites/submit/)
|
||||||
* [Follow @processwire on Twitter](http://twitter.com/processwire/)
|
* [Follow @processwire on Twitter](http://twitter.com/processwire/)
|
||||||
* [Contact ProcessWire](https://processwire.com/contact/)
|
* [Contact ProcessWire](https://processwire.com/contact/)
|
||||||
* [Sites running ProcessWire](https://processwire.com/about/sites/)
|
|
||||||
|
|
||||||
------
|
------
|
||||||
|
|
||||||
Copyright 2019 by Ryan Cramer / Ryan Cramer Design, LLC
|
Copyright 2020 by Ryan Cramer / Ryan Cramer Design, LLC
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user