forked from timschofield/webERP-svn
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refreshed README file in markdown format (#12)
* Refreshed README file in markdown format. Will require further update once GitHub wiki pages are complete. * Refreshed README file in markdown format. Will require further update once GitHub wiki pages are complete. * Refreshed README file in markdown format. Will require further update once GitHub wiki pages are complete.
- Loading branch information
1 parent
22d41e2
commit c075e57
Showing
2 changed files
with
67 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # [webERP - Accounting and Business Administration ERP System](http://http://www.weberp.org/) | ||
| [](http://sourceforge.net/projects/web-erp/files/latest/download) [](http://sourceforge.net/projects/web-erp/files/latest/download)   | ||
| ## Introduction | ||
| webERP is a free open-source ERP system, providing best practise, multi-user business administration and accounting tools over the web. For further information and for a full list of features, please visit the support site at: http://www.weberp.org/ | ||
|
|
||
| ## Demo | ||
| A live demo of the latest release is available on the webERP support site, where you can login and experiment with all the webERP features: http://www.weberp.org/weberp/ | ||
|
|
||
| ## Download | ||
| The latest stable version is currently v4.14.1, and can be downloaded from SourceForge. | ||
| [ | ||
| Download the latest official webERP release](http://sourceforge.net/projects/web-erp/files/latest/download) | ||
|
|
||
| ## Requirements | ||
| - A web server - webERP has been tested on Apache, NGINX, lighthttpd, and Hiawatha | ||
| - PHP version 5.1 and above | ||
| - MySQL version 4.3 and above, or MariaDB version 5.1 and above | ||
| - A web browser with HTML5 compatibility | ||
|
|
||
| Further information about hardware and software requirements is available in the [documentation](http://www.weberp.org/weberp/ManualContents.php?ViewTopic=Requirements). | ||
|
|
||
| ## Installation | ||
| ### New installation | ||
| 1. [Download the latest official webERP release.](http://sourceforge.net/projects/web-erp/files/latest/download) | ||
| 2. Unzip the downloaded file. | ||
| 3. Create an empty database, taking note of your username, password, hostname, and database name. | ||
| 4. Everything inside the folder you unzipped needs to be uploaded/copied to your webserver, for example, into your `public_html` or `www` or `html` folder (the folder will already exist on your webserver). | ||
| 5. In your browser, enter the address to your site, such as: www.example.com (or if you uploaded it into another subdirectory such as foldername use www.example.com/foldername) | ||
| 6. Follow the instructions that appear in your browser for installation. | ||
|
|
||
| ### Upgrading | ||
| 1. [Download the latest official webERP release.](http://sourceforge.net/projects/web-erp/files/latest/download) | ||
| 2. Unzip the downloaded file. | ||
| 3. Backup the `config.php` script and `companies/` directory from your previous installation. | ||
| 3. Everything inside the folder you unzipped needs to be uploaded/copied to your webserver, overwriting your previous installation. | ||
| 4. Verify that the `config.php` script and `companies/` directory are intact, and if not, restore them from your backup. | ||
| 5. In your browser, enter the address to your site, such as: www.example.com (or if you uploaded it into another subdirectory such as foldername use www.example.com/foldername). | ||
| 6. After you log-in, if any database upgrades are required, you will be prompted to install them. | ||
|
|
||
| Further information about installation and upgrading is available in the [documentation](http://www.weberp.org/weberp/ManualContents.php?ViewTopic=GettingStarted). | ||
|
|
||
| ## Documentation | ||
| The webERP documentation is included in every installation, and can accessed by clicking on the `Manual` button on the top menu bar. The documentation is also available within the [live demo.](http://www.weberp.org/weberp/ManualContents.php) | ||
|
|
||
| ## Support | ||
| Free support is available 24/7, provided by our enthusiastic community of actual webERP users, integrators, and the developers themselves. | ||
| The primary means of support is through the forum at: http://www.weberp.org/forum | ||
| You may also join the mailing list at: http://lists.sourceforge.net/lists/listinfo/web-erp-users | ||
| The answers to most questions can be found by searchng the forums, or the mailing list archives at: https://sourceforge.net/p/web-erp/mailman/ | ||
|
|
||
| ## Contribute to the webERP project | ||
| Contributions of code and documententation including How-Tos with screen-shots etc are very much appreciated. If your business has done such training materials for your own team this will no doubt be useful to many others and a productive way that you could contribute. Contributions in the form of bug reports or other feedback through the forums or mailing lists above also help to improve the project. | ||
|
|
||
| Guidelines for contributing code can be found at: http://www.weberp.org/Development.html | ||
|
|
||
| Developers interested in contributing should read this document carefully and follow the guidelines therein. Standards and conventions used in the code are rigorously applied in the interests of consistency and readability. | ||
|
|
||
| ## Legal | ||
| This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. | ||
|
|
||
| This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
|
|
||
| A copy of the GNU General Public License is included in the doc directory along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | ||
|
|
||
| Copyright © weberp.org 2003-2018 - Contact: info@weberp.org | ||
|
|
||
| Note that as well as the name of the project/development community of webERP "weberp.org" is a domain name administered by the project administrator on behalf of the project. Irrespective of misleading comments elsewhere, copyright of all contributed code remains with the developer who contributed it and the "weberp.org" project is the collective name for the webERP development team. |
This file was deleted.
Oops, something went wrong.