From c2a23ce607cbaf2f76bc73d6e0fcecf629b97dad Mon Sep 17 00:00:00 2001 From: Sammy Fung Date: Mon, 2 Oct 2023 14:21:21 +0800 Subject: [PATCH] add the missing Installation from Git procedures to README. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 48e53cf..2ed5a21 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,21 @@ To create, modify and delete invoices, please use Django admin to do it before i ## PDF/Print export invoicepi can export an invoice to a PDF file for email/archive or simple HTML text for printing. + +## Installation from Git + +1. Git clone invoicepi to your Django project. + +2. add 'invoicepi.invoicepi' to INSTALLED_APPS array of settings.py in your Django project. + +3. add the following path() line to urls.py in your Django project, please do not forget to import include from django.urls. + +``` + path('invoicepi/', include('invoicepi.invoicepi.urls')), +``` + +4. Try local test. Login and main page of invoicepi is located at [/invoicepi](http://localhost:8000/invoicepi) of your Django project, and use Django admin to modify contents. + +``` +http://localhost:8000/invoicepi +``` \ No newline at end of file