Browse Source

Updates instructions within all .md files

Kovah 2 years ago
parent
commit
1eff710446
5 changed files with 37 additions and 25 deletions
  1. 16 13
      CONTRIBUTING.md
  2. 5 5
      DEVELOPMENT.md
  3. 3 1
      LICENSE.txt
  4. 9 5
      README.md
  5. 4 1
      ipconfig.php.example

+ 16 - 13
CONTRIBUTING.md

@@ -4,11 +4,13 @@
 
 Every help is welcome, you don't have to be a professional PHP developer or SQL database engineer.
 If you are not familiar with PHP or coding in general you could also help us in other ways.
+You may also join our [Slack Chat](https://invoiceplane-slack.herokuapp.com/) to discuss certain
+topics with other developers or get some help.
 
 ## Contents
 
 * Get familiar with our Development Guidelines
-* Get familiar with our Development Guidelines
+* Tools for development
 * Contributing Code
 
 ---
@@ -26,14 +28,7 @@ Use JShint / JSlint to check your JavaScript code and try to resolve all code is
 ### CSS
 We use SASS only.
 
-
-## Tools for development
-We received some licenses for commercial development tools you can use if you want. Please contact use at mail@invoiceplane.com to get the license / access as we can't publish them here.
-
-* JetBrains PhpStorm (PHP IDE)
-* Balsamiq Mockups
-* Mailtrap.io eMail Testing Solution
-
+---
 
 ## Contributing Code
 
@@ -51,9 +46,17 @@ We received some licenses for commercial development tools you can use if you wa
 4. Submit the pull request, reference the issue ID in the title and add a meaningful description.
 
 
-Please ask questions related to this process if you are unclear.
+Please ask questions related to this process if you are unclear. Asking before doing anything may save you and us time.
 
 ---
-  
-*Please notice: The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com
-and their usage is restricted! For more information visit invoiceplane.com/license-copyright*
+
+## Tools for development
+We received some licenses for commercial development tools you can use if you want. Please contact use at mail@invoiceplane.com to get the license / access as we can't publish them here.
+
+* JetBrains PhpStorm (PHP IDE)
+* Mailtrap.io eMail Testing Solution
+
+---
+
+> _The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com
+and their usage is restricted! For more information visit invoiceplane.com/license-copyright_

+ 5 - 5
DEVELOPMENT.md

@@ -29,10 +29,10 @@ The following tasks need to be accomplished before starting to work on and with
 
 The following steps are required to make InvoicePlane runnable:
 
-* Duplicate the `ipconfig.php.example` file and rename the duplicate to `ipconfig.php`.
+* Make a copy of the `ipconfig.php.example` file and rename the copy to `ipconfig.php`.
 * Run `composer install`.
 * Run `npm install`.
-* Run `grunt`.
+* Run `grunt build`.
 
 Then point your webserver to the InvoicePlane directory. That's it.
 
@@ -61,6 +61,6 @@ On the setup screen specify localhost, root, *blank password*, invoiceplane as t
 __Ask questions!__ Please ask questions related to this process if you are unclear.
 
 ---
-  
-*Please notice: The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com
-and their usage is restricted! For more information visit invoiceplane.com/license-copyright*
+
+> _The name 'InvoicePlane' and the InvoicePlane logo are both copyright by Kovah.de and InvoicePlane.com
+and their usage is restricted! For more information visit invoiceplane.com/license-copyright_

+ 3 - 1
LICENSE.txt

@@ -1,5 +1,5 @@
 ================================================================================
-Copyright Notice for InvoicePlane
+Copyright Notice for the InvoicePlane trademark
 ================================================================================
 The name 'InvoicePlane' and the InvoicePlane logo are original copyright
 of InvoicePlane.com / Kovah.de and the following restrictions apply to
@@ -19,6 +19,8 @@ You are NOT allowed to:
 - sell or redistribute the application under the name 'InvoicePlane' and the
     InvoicePlane logo.
 
+Please contact us for more information or permission for exceptional cases.
+
 ================================================================================
 License for InvoicePlane
 ================================================================================

+ 9 - 5
README.md

@@ -10,8 +10,8 @@ For more information visit __[InvoicePlane.com](https://invoiceplane.com)__ or t
 
 1. Download the latest version [from the InvoicePlane website](https://invoiceplane.com/downloads).
 2. Extract the package and copy all files to your webserver / webspace.
-3. Make a copy of the `ipconfig.php.example` file and rename it to `ipconfig.php`.
-4. Open the `ipconfig.php` file and add your URL in it.
+3. Make a copy of the `ipconfig.php.example` file and rename this copy to `ipconfig.php`.
+4. Open the `ipconfig.php` file and add your URL like specified in the file.
 5. Open `http://your-invoiceplane-domain.com/index.php/setup` and follow the instructions.
 
 
@@ -19,28 +19,32 @@ _Notice: We strongly disadvise to download the InvoicePlane package from Github,
 
 #### Remove `index.php` from the URL
 
+If you want to remove `index.php` from the URL, follow these instructions. However, this is not a requirement for InvoicePlane to run. If it's not working correctly, move back and use the application with out removint that part from the URL.
+
 1. Make sure that [mod_rewrite](https://go.invoiceplane.com/apachemodrewrite) is enabled on your web server.
 2. Set the `REMOVE_INDEXPHP` setting in your `ipconfig.php` to `true`.
 3. Rename the `htaccess` file to `.htaccess`
 
-If you want to install InvoicePlane in a subfolder (e.g. `http://your-invoiceplane-domain.com/invoices/`) you have to change the .htaccess file. The instructions can be found within the file.
+If you want to install InvoicePlane in a subfolder (e.g. `http://your-invoiceplane-domain.com/invoices/`) you have to change the `ipconfig.php` and `.htaccess` file. The instructions can be found within the files.
 
 ---
 
 ### Support / Development / Chat
 
+Need some help or want to talk with other about InvoicePlane? Follow these links to get in touch.
+
 [![Wiki](https://img.shields.io/badge/Help%3A-Official%20Wiki-429ae1.svg)](https://wiki.invoiceplane.com/)  
 [![Community Forums](https://img.shields.io/badge/Help%3A-Community%20Forums-429ae1.svg)](https://community.invoiceplane.com/)  
+[![Slack Chat](https://img.shields.io/badge/Development%3A-Slack%20Chat-429ae1.svg)](https://invoiceplane-slack.herokuapp.com/)  
 [![Issue Tracker](https://img.shields.io/badge/Development%3A-Issue%20Tracker-429ae1.svg)](https://development.invoiceplane.com/)  
 [![Roadmap](https://img.shields.io/badge/Development%3A-Roadmap-429ae1.svg)](https://go.invoiceplane.com/roadmapv1)  
-[![Slack Chat](https://img.shields.io/badge/Development%3A-Slack%20Chat-429ae1.svg)](https://invoiceplane-slack.herokuapp.com/)  
 [![Contribution Guide](https://img.shields.io/badge/Development%3A-Contribution%20Guide-429ae1.svg)](CONTRIBUTING.md)  
 
 ---
 
 ### Security Vulnerabilities
 
-If you discover a security vulnerability please send an e-mail to mail@invoiceplane.com before disclosing the vulnerability to the public!
+If you discover a security vulnerability please send an e-mail to mail@invoiceplane.com before disclosing the vulnerability to the public.
 All security vulnerabilities will be promptly addressed.
 
 ---

+ 4 - 1
ipconfig.php.example

@@ -2,12 +2,15 @@
 # InvoicePlane Configuration File
 
 # Set your URL without trailing slash here, e.g. http://your-domain.com
+# If you use a subdomain, use http://subdomain.your-domain.com
+# If you use a subfolder, use http://your-domain.com/subfolder
 IP_URL=
 
 # Having problems? Enable debug by changing the value to 'true' to enable advanced logging
 ENABLE_DEBUG=false
 
-# To remove index.php from the URL, set this setting to 'true'
+# To remove index.php from the URL, set this setting to 'true'.
+# Please notice the additional instructions in the htaccess file!
 REMOVE_INDEXPHP=false
 
 # These database settings are set during the initial setup