diff options
author | Camil Staps | 2015-02-25 22:00:40 +0100 |
---|---|---|
committer | Camil Staps | 2015-02-25 22:00:40 +0100 |
commit | 3f414997f4e18117f290d7df9f162b7fffd3cccd (patch) | |
tree | 596f5dffb645dbdf5dd4a10ed143df247631f625 /README.md | |
parent | invoices in the future aren't open (diff) |
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -11,7 +11,7 @@ Its intuitive interface lets you use it efficiently from the start. See the Usag * If you're going to use this application for sensitive data, you should seriously consider using HTTPS. -* Every request that is not a file or directory itself should link back to /index.php. The query string should be left intact. For nginx, this means: +* Every request that is not a file or directory itself should link back to `/index.php`. The query string should be left intact. For nginx, this means: try_files $uri $uri/ /index.php$is_args$query_string; @@ -49,7 +49,7 @@ In classes/constants.php, you should at least set the following options: ## Create database tables and files folder -Open up /install/index.php. When you click 'create tables', it will create all the necessary tables in the database. This is also a first check to see if your MySQL credentials are valid. +Open up `/install/index.php`. When you click 'create tables', it will create all the necessary tables in the database. This is also a first check to see if your MySQL credentials are valid. In the same file, click 'create folders'. This will create your files and trash folder. This is also a check to make sure that your permissions are correct. You can also create these folders yourself, if you make sure the webserver has permission to it. @@ -59,15 +59,15 @@ The files folder will be used to put generated invoices in. Make your server use ## Personalizing -If you add a file logo-correspondence.png in the files folder, this image will be used as your logo in generated invoices. +If you add a file `/files/logo-correspondence.png` (or whatever directory you're using for your files), this image will be used as your logo in generated invoices. # Upgrading 1. Always make a backup of your current files! 1. First note down your current version number from the About page in BusinessAdmin. 1. Update the directory. -1. Make sure you restore your personal settings in /conf.php and /classes/constants.php, if these files were updated. -1. Go to /install/upgrade.php and fill in your old version number. This will alter database tables, if necessary. +1. Make sure you restore your personal settings in `/conf.php` and `/classes/constants.php`, if these files were updated. +1. Go to `/install/upgrade.php` and fill in your old version number. This will alter database tables, if necessary. # Usage @@ -105,7 +105,7 @@ Here you can link new assignments to your offers. You can also edit old assignme ## Trash -When you delete an invoice file, it's not actually deleted. Instead, it's placed in a directory called `trash` inside your files directory. These files are listed by name and removal time. This way, you never really lose your file. +When you delete an invoice file, it's not actually deleted. Instead, it's placed in a directory called `trash` inside your `files` directory. These files are listed by name and removal time. This way, you never really lose your file. # ToDo |