Skip to content

Commit

Permalink
Explain fork purpose in README
Browse files Browse the repository at this point in the history
  • Loading branch information
pchaigno authored Sep 13, 2016
1 parent 294d3ba commit d5e1022
Showing 1 changed file with 4 additions and 24 deletions.
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# Sublime SourcePawn Completions

A Sublime Text 2 plugin that dynamically genenerates completions for SourcePawn.
This fork exists only for the purpose of locking the version to `294d3ba` in [Linguist](https://github.com/github/linguist).
For syntax highlighting in Sublime Text, you should use [austinwagner/sublime-sourcepawn](https://github.com/austinwagner/sublime-sourcepawn).

Based off [SourcePawn Snippet Generator by MCPAN](https://forums.alliedmods.net/showpost.php?p=1866026&postcount=19).

## Installing

Clone this repository into a subfolder of your Packages directory.

## Configuration

Create an `SPCompletions.sublime-settings` file in your User directory that looks like:

{
"include_directory": "C:\\srcds\\tf\\addons\\sourcemod\\scripting\\include"
}

or edit same file in the installed package folder.

The path must be an absolute path. Relative paths are unsupported.

If you are upgrading from an older version, note that this configuration option has a different name.

## Usage

SP Completions is automatically active on .sp and .inc files. The completion list updates whenever you stop typing for 1 second or when you save the file.
The last version of sublime-sourcepawn does not contain the `.tmLanguage` file necessary for GitHub's syntax highlighting.
For more context, see [github/linguist#3070](https://github.com/github/linguist/issues/3070).

0 comments on commit d5e1022

Please sign in to comment.