Skip to content

Commit

Permalink
add README and HISTORY
Browse files Browse the repository at this point in the history
  • Loading branch information
sakra committed Nov 28, 2016
1 parent c6ea4a4 commit 308d0da
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
3 changes: 3 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 1.0.0 (2016-11-28)

* first release.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
CMakeBBLM
=========

CMakeBBLM is a script that generates a [BBEdit codeless language module][clm] for [CMake][cmake].

Features
--------

* Dynamically generates a BBEdit codeless language module for the actual CMake version installed.
* Supports text completion for CMake built-in commands, properties and variables.
* Supports BBEdit function pop-ups for user-defined CMake functions and macros.

Requirements
------------

* BBEdit 10 or newer.
* CMake 2.8.12 or newer.

Installation
------------

Execute the shell script `install.sh` with Terminal.app to generate and install the BBEdit language
module:

$ ./install.sh
cmake.plist -> /Users/sakra/Dropbox/Application Support/BBEdit/Language Modules/cmake.plist
CMake BBEdit language module installed. Please restart BBEdit.

The generated module is tailored to the version of CMake installed on the system, i.e., it will
only support keywords and predefined names valid for that version.

The install script copies the generated language module to BBEdit's application support folder in
the Dropbox data folder or in the user's Library folder.

Usage
-----

Restart BBEdit after installation. The language `CMake` is then available in an editor window's
language popup menu. The `CMakeBBLM` module is automatically used for files named `CMakeLists.txt`
and for files with the extensions `.cmake` or `.ctest`.

[clm]:http://www.barebones.com/support/develop/clm.html
[cmake]:https://cmake.org/

0 comments on commit 308d0da

Please sign in to comment.