Skip to content

Commit 7f52d44

Browse files
authored
add simplified v2 installation instructions
1 parent 47b2b17 commit 7f52d44

File tree

1 file changed

+35
-0
lines changed
  • en/50_Open_Source/Gitify/01_Installation

1 file changed

+35
-0
lines changed

en/50_Open_Source/Gitify/01_Installation/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1+
## v2
2+
3+
As of Gitify v2 and up, installation has been simplified and is handled entirely via composer. You can choose to install Gitifiy globally, or locally to a project.
4+
5+
For a **global** installation, run:
6+
7+
````
8+
composer global require modmore/gitify:^2
9+
````
10+
11+
After the installation completes, you'll use `gitify` as the main command.
12+
13+
For a **local project installation**, run:
14+
15+
````
16+
composer require modmore/gitify:^2
17+
````
18+
19+
After the installation completes, you'll use `vendor/bin/gitify` as the main command.
20+
21+
Finally, for **development or advanced usage**, you may continue to use the manual installation steps:
22+
23+
````
24+
git clone https://github.com/modmore/Gitify.git Gitify
25+
cd Gitify
26+
composer install --no-dev
27+
chmod +x bin/gitify
28+
````
29+
30+
In this case you'll use `bin/gitify` as the main command.
31+
32+
_Note that the gitify executable has been moved into the `bin` directory on v2. You may need to adjust your `$PATH` accordingly._
33+
34+
## v1 (and prior)
35+
136
New as of v0.2 is that dependencies are managed via [Composer](https://getcomposer.org/), most notably it has been rebuilt on top of Symfony's Console component to provide a more feature-packed base to build from. [Follow these instructions if you haven't installed Composer before](https://getcomposer.org/doc/00-intro.md)
237

338
To get started with Gitify, it's easiest to set up a local clone of this repository. It doesn't matter in which folder clone it to. On Unix/Linux systems you can choose your home directory. After that, run Composer to download the dependencies, and finally make the Gitify file executable to run it.

0 commit comments

Comments
 (0)