Skip to content

Added package install instructions #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added package install instructions #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ This project is based on an auto-generated [conversion][1] of [the official CFML

Pull requests welcome.

## Installation

1. Clone this repo or download the zip.
2. In Atom, open a command line in the repo folder you just cloned or extracted from the zip (atom-language-cfml).
3. On the command line, enter: apm install language-cfml
4. After the install completes, you will need to close and re-open Atom to see the new package applied to your cfml code.

Copy link
Owner

@atuttle atuttle Nov 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the recommended approach for someone who might want to modify the plugin, but the average user can just install it through the in-app plugin installer. Maybe update to indicate that?

## Tests
[![Build Status](https://travis-ci.org/atuttle/atom-language-cfml.svg?branch=master)](https://travis-ci.org/atuttle/atom-language-cfml)

Expand Down