mirror of
https://github.com/e107inc/e107.git
synced 2025-01-16 20:28:28 +01:00
Improvements to README.md
- MOD: Removed hard-coded version number - NEW: Added badge for latest version number - NEW: Added badge for build results - NEW: Added badge for code coverage - NEW: Added table of contents - FIX: Clarification of system requirements - MOD: Combined installation insructions into "Installation" secion - MOD: Standard installation instructions now explain how to download e107 - FIX: Clarification of Git installation instructions - FIX: Grammar in "Reporting Bugs" section - MOD: Renamed "Pull-Requests" section to "Contributing to Development" - FIX: Readability of the "Contributing to Development" section - FIX: Grammar in "Donations" section - MOD: Replaced all HTTP links with HTTPS
This commit is contained in:
Nick Liu
parent
16ca1494e3
commit
38c8c71a09
110
README.md
110
README.md
@ -1,78 +1,104 @@
|
||||
## e107 [Content Management System][1] (CMS) - v2
|
||||
# e107 Content Management System
|
||||
|
||||
[](https://gitter.im/e107inc/e107?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://github.com/e107inc/e107/releases)
|
||||
[](https://github.com/e107inc/e107/actions)
|
||||
[](https://codecov.io/gh/e107inc/e107/)
|
||||
|
||||
### What is e107?
|
||||
e107 is a free (open-source) content management system which allows you to easily manage and publish your content online. Developers can save time in building websites and powerful online applications. Users can avoid programming completely! Blogs, Websites, Intranets - e107 does it all.
|
||||
**[e107][1]** is a free and open-source content management system (CMS) which allows you to manage and publish your content online with ease. Developers can save time in building websites and powerful online applications. Users can avoid programming completely! Blogs, websites, intranets – e107 does it all.
|
||||
|
||||
### Requirements
|
||||
## Table of Contents
|
||||
|
||||
#### Minimum
|
||||
* [e107 Content Management System](#e107-content-management-system)
|
||||
* [Table of Contents](#table-of-contents)
|
||||
* [Requirements](#requirements)
|
||||
* [Minimum](#minimum)
|
||||
* [Recommended](#recommended)
|
||||
* [Installation](#installation)
|
||||
* [Standard Installation](#standard-installation)
|
||||
* [Git Installation (developer version)](#git-installation-developer-version)
|
||||
* [Reporting Bugs](#reporting-bugs)
|
||||
* [Contributing to Development](#contributing-to-development)
|
||||
* [Donations](#donations)
|
||||
* [Support](#support)
|
||||
* [License](#license)
|
||||
|
||||
* A Web-Server (Apache or Microsoft IIS) running PHP v5.6 or higher and MySQL 4.x or 5.x.
|
||||
* FTP access to your webserver and an FTP program such as Filezilla
|
||||
* Username/Password to your MySQL Database
|
||||
## Requirements
|
||||
|
||||
#### Recommended
|
||||
### Minimum
|
||||
|
||||
* A Linux based Webserver running Apache 2.x, PHP 7.x and MySQL 5.x (LAMP)
|
||||
* A registered Domain Name
|
||||
* Access to a Server Control Panel (such as cPanel)
|
||||
* A web server (Apache or Microsoft IIS) running PHP 5.6 or newer
|
||||
* MySQL 4.x or newer, or MariaDB
|
||||
* FTP access to your web server and an FTP client (such as FileZilla)
|
||||
* Username and password to your MySQL database
|
||||
|
||||
### Recommended
|
||||
|
||||
* Apache 2.2 or newer on Linux with PHP 7.0 or newer
|
||||
* MySQL 5.x or newer, or MariaDB
|
||||
* A registered domain name
|
||||
* Access to a server control panel (such as cPanel)
|
||||
|
||||
|
||||
### Standard Installation
|
||||
## Installation
|
||||
|
||||
* Unzip/Extract the compressed file onto your server.
|
||||
* Point your browser to the *http://localhost/YOUR FOLDER/install.php* (depending on your webserver setup)
|
||||
* Follow the installation wizard
|
||||
### Standard Installation
|
||||
|
||||
1. [Download e107](https://e107.org/download).
|
||||
2. Unzip/Extract the compressed file onto your desired web root.
|
||||
This is often a folder called `public_html`.
|
||||
3. Point your browser to the `install.php` script (e.g., `https://example.com/subfolder/install.php`)
|
||||
4. Follow the installation wizard in your browser.
|
||||
|
||||
|
||||
|
||||
### Git Installation (developer version)
|
||||
|
||||
* Run the following commands ( where 'youraccount' is the folder above your public_html folder and xxx:xxx is the default owner for your files - this can be found using FileZilla and FTP)
|
||||
```
|
||||
cd youraccount
|
||||
git clone https://github.com/e107inc/e107.git public_html
|
||||
chown -R xxx:xxx public_html
|
||||
```
|
||||
* Point your browser to the *http://localhost/YOUR FOLDER/install.php* (depending on your webserver setup)
|
||||
* Follow the installation wizard
|
||||
1. Run the following commands, replacing '~' with your document root (the parent of `public_html`) and xxx:xxx is the intended owner of your e107 files.
|
||||
```
|
||||
cd ~
|
||||
git clone https://github.com/e107inc/e107.git public_html
|
||||
chown -R xxx:xxx public_html
|
||||
```
|
||||
2. Point your browser to the `install.php` script (e.g., `https://example.com/subfolder/install.php`)
|
||||
3. Follow the installation wizard in your browser.
|
||||
|
||||
|
||||
|
||||
### Reporting Bugs
|
||||
## Reporting Bugs
|
||||
|
||||
Be sure you are using the most recent version prior to reporting an issue.
|
||||
You may report any bugs or feature requests on GitHub (https://github.com/e107inc/e107/issues)
|
||||
Be sure you are using the most recent version of e107 prior to reporting an issue.
|
||||
You may report any bugs and make feature requests [e107's GitHub Issues page](https://github.com/e107inc/e107/issues).
|
||||
|
||||
|
||||
|
||||
### Pull-Requests
|
||||
## Contributing to Development
|
||||
|
||||
* Please submit 1 pull-request for each Github #issue you may work on.
|
||||
* Make sure that only the lines you have changed actually show up in a file-comparison (diff) ie. some text-editors alter every line so this should be avoided.
|
||||
* Make sure you are using rebase on your local .git/config file.
|
||||
ie. [branch "master"]
|
||||
rebase = true`
|
||||
* Here's a small tutorial to give you a start on [CONTRIBUTING](CONTRIBUTING.md)
|
||||
* Please submit 1 pull request for each GitHub issue you work on.
|
||||
* Make sure that only the lines you have changed actually show up in a file-comparison (diff).
|
||||
Some text editors alter every line; this should be avoided.
|
||||
* It is recommended to configure `git pull` to rebase on the master branch by default to avoid unnecessary merge commits. You can set this up in your copy of the repo's `.git/config` file like so:
|
||||
```
|
||||
[branch "master"]
|
||||
rebase = true
|
||||
```
|
||||
* See the [CONTRIBUTING](.github/CONTRIBUTING.md) document for a tutorial on getting started.
|
||||
|
||||
### Donations
|
||||
If you like e107 and wish to help it to improve - please consider making a small donation.
|
||||
## Donations
|
||||
If you like e107 and wish to help it to improve, please consider making a small donation.
|
||||
|
||||
* Bitcoin address: 18C7W2YvkzSjvPoW1y46PjkTdCr9UzC3F7
|
||||
* Paypal: donate (at) e107.org
|
||||
* PayPal: donate (at) e107.org
|
||||
|
||||
|
||||
|
||||
### Support
|
||||
* http://e107help.org
|
||||
## Support
|
||||
* https://e107help.org
|
||||
|
||||
|
||||
|
||||
### License
|
||||
## License
|
||||
|
||||
* e107 is released under the terms and conditions of the GNU General Public License (http://www.gnu.org/licenses/gpl.txt)
|
||||
|
||||
[1]: http://e107.org
|
||||
[2]: http://www.e107.org
|
||||
[1]: https://e107.org
|
||||
Loading…
x
Reference in New Issue
Block a user