Commit c24fbb12 authored by luka8088's avatar luka8088

Documentation update (alpha)

parent 6fcb3c70
......@@ -7,16 +7,21 @@ Basic usage
Phlint can be downloaded from [the download section](https://bitbucket.org/luka8088/phlint/downloads) and used
as a command line utility:
# To download run:
wget https://bitbucket.org/luka8088/phlint/downloads/phlint-0.2.6.phar -O phlint.phar
# To invoke run:
php phlint.phar /path/to/project
Alternatively it can be included in the project through composer:
# To install run:
composer require luka8088/phlint
# To invoke run:
./vendor/bin/phlint
Basic Configuration
-------------------
......
......@@ -4,11 +4,11 @@ Phlint - PHP Linter, Code Analyzer and Tester
Introduction
------------
Phlint is a tool with an aim to help maintain quality of php code. It focuses on how the code works rather
than how the code looks. The main difference between Phlint and other php code analysis tools is that Phlint
is doing a deep semantic analysis while most of the other tools only do shallow or stylistic analysis.
Phlint is a tool with an aim to help maintain quality of php code by analyzing code and pointing out potential code
issues. It focuses on how the code works rather than how the code looks. Phlint is designed from the start to do
deep semantic analysis rather than doing only shallow or stylistic analysis.
Documentation
-------------
1. [Getting Started](/luka8088/phlint/src/master/documentation/01-getting-started.md)
1. [Getting Started](https://bitbucket.org/luka8088/phlint/src/master/documentation/01-getting-started.md)
Copyright (c) 2016 Luka Unuk (luka8088) <[email protected]>.
Copyright (c) 2016 Luka Unuk <[email protected]>.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......
......@@ -4,9 +4,9 @@ Phlint - PHP Linter, Code Analyzer and Tester
Introduction
------------
Phlint is a tool with an aim to help maintain quality of php code. It focuses on how the code works rather
than how the code looks. The main difference between Phlint and other php code analysis tools is that Phlint
is doing a deep semantic analysis while most of the other tools only do shallow or stylistic analysis.
Phlint is a tool with an aim to help maintain quality of php code by analyzing code and pointing out potential code
issues. It focuses on how the code works rather than how the code looks. Phlint is designed from the start to do
deep semantic analysis rather than doing only shallow or stylistic analysis.
Basic usage
-----------
......@@ -14,14 +14,18 @@ Basic usage
Phlint can be downloaded from [the download section](https://bitbucket.org/luka8088/phlint/downloads) and used
as a command line utility:
# To download run:
wget https://bitbucket.org/luka8088/phlint/downloads/phlint-0.2.6.phar -O phlint.phar
# To invoke run:
php phlint.phar /path/to/project
Alternatively it can be included in the project through composer:
# To install run:
composer require luka8088/phlint
# To invoke run:
./vendor/bin/phlint
Documentation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment