From 56107e083d4862d309af6551cb9e6099ac93c0ca Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Thu, 22 May 2014 17:54:47 +0530 Subject: [PATCH] updated readme --- README.md | 40 ++++++++-------------------------------- 1 file changed, 8 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 28dd978089..f7305c495f 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,17 @@ ## frappe [![Build Status](https://travis-ci.org/frappe/frappe.png)](https://travis-ci.org/frappe/frappe) -Full-stack web application framework that uses Python/MySql on the server side and a tightly integrated client side library. Primarily built for erpnext. -Projects: [erpnext](http://erpnext.org) | [frappe/erpnext](https://github.com/frappe/erpnext) +Full-stack web application framework that uses Python and MariaDB on the server side and a tightly integrated client side library. [Built for ERPNext](https://erpnext.com) -## Setup +### Installation -To start a new project, in the application root: +[Install via Frappe Bench](https://github.com/frappe/frappe-bench) -Install: +### Website -* Go to the project folder -* Install frappe and your app: -``` -mkdir bench -cd bench -git clone https://github.com/frappe/frappe.git -git clone https://github.com/frappe/[your_app] -sudo pip install -e frappe/ erpnext/ your_app/ -mkdir sites -echo app >> sites/apps.txt -cd sites -frappe site.local --install dbname -frappe site.local --install_app your_app -``` -* Run development server: +For details and documentation, see the website -``` -cd sites -frappe site.local --serve -``` +[https://frappe.io](https://frappe.io) -enjoy! +### License -## wnf.py - -`frappe --help` for more info - -## License - -frappe is freely available to use under the MIT License +MIT License