add the missing Installation from Git procedures to README.

sammyfung · Oct 2, 2023 · c2a23ce · c2a23ce
1 parent 1ba2f38
commit c2a23ce
Showing 1 changed file with 18 additions and 0 deletions.
diff --git 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
+```