Skip to content

Commit

Permalink
The final commits for 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dans98 committed Jun 1, 2015
1 parent 508396a commit 4bd7099
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 3 deletions.
11 changes: 11 additions & 0 deletions Messages/1.1.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
ApiGen
======

Thank you for upgrading ApiGen for Sublime Text 3.

The follwing new features have been added since the last rlease.

* Generate Freeform - Works the same as the Generate option, but the user is prompted to provide additonal command line arguments.

* Freeform - The usere is presented a prompt, and allowd to pass any arguments to ApiGen they wish.

1 change: 1 addition & 0 deletions Messages/install.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Thanks for installing ApiGen for Sublime Text 3.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ Currently The plugin allows click to run functunallity. Simply right click on an

### Options
* **Generate** - Takes the clicked on file, and uses its path as a starting point to walk back to the filesystem root. The plugin checks each directory along the way for an *apigen.neon* file. It will halt it's walk if it finds a file, and call ApiGen passing the *apigen.neon* file path as the (--config) option.
* **Generate Freeform** - Works the same as the Generate option, but the user is prompted to provide additonal command line arguments.
* **Selfupdate** - Runs the ApiGen (selfupdate) option, to update the apigen.phar file to the latest revision.
* **Version** - Runs the ApiGen (-v) version option.
* **Freeform** - The usere is presented a prompt, and allowd to pass any arguments to ApiGen they wish.

## Instalation

### Requirements
* You must meet the requirements of, and have [ApiGen](https://github.com/ApiGen/ApiGen) instilled on your machine as a [phar](http://php.net/manual/en/intro.phar.php) file.
* You must meet the requirements of, and have [ApiGen](https://github.com/ApiGen/ApiGen) instilled on your machine.


### Steps
Expand All @@ -25,10 +27,12 @@ Currently The plugin allows click to run functunallity. Simply right click on an
1. From the main menu of Sublime Text go to **Preferences**
2. Choose **Package Settings**
3. Choose **ApiGen**
4. Choose **Settings - Default**
4. Choose **Settings - User**
5. Set the setting to the approrite value for your machine.
* **phpBin** - The location of the php executable on your machine.
* **pharPath** - The location of the apigen.phar file on your machine.
* **pharPath** - The location of apigen on your machine.
* **configFileName** - The name of the config file to search for. The default is **apigen.neon**.
* **additionalGenerateArgs** - Additonal command line arguments, to be appended to the end of the Generate command.


## Author
Expand Down
4 changes: 4 additions & 0 deletions messages.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"install": "Messages/install.txt",
"1.1.0": "Messages/1.1.0.txt",
}

0 comments on commit 4bd7099

Please sign in to comment.