README.md

MavensMate for Atom (beta)

Development Suspended

MavensMate users,

I have temporarily suspended development & support for MavensMate to focus on spending time with my newborn daughter. If you are experiencing an issue with MavensMate, I encourage you to use the Force.com IDE, Developer Console, or one of the many other 3rd party tools for building Salesforce applications until development resumes.

Thanks very much for your support.

-Joe

MavensMate for Atom is a plugin for the Atom text editor that enables Salesforce developers to build App Cloud/Force.com applications inside Atom.

Platform Support

Tested on OSX 10.10.x, Windows 7/8, Ubuntu 12

Installation

Prerequisites

MavensMate-app

MavensMate for Atom requires MavensMate-app to be installed and running.

Plugin Installation

From Atom

Open Atom > Preferences... > + Install > Search for "MavensMate" > Install

From Command Line

apm install MavensMate-Atom

Note for Windows/Linux users: We've performed the bulk of our testing on OSX. If you encounter issues, you are encouraged to submit a bug report.

Configuration

Global Settings (settings managed by MavensMate-app)

MavensMate > Settings > Global Settings

Plugin Settings

MavensMate > Settings > Plugin Settings

Create a Project

To create your first MavensMate for Atom project:

1. Be sure to configure your mm_workspace: MavensMate menu > Settings > Global Settings
2. MavensMate > New Project

Run MavensMate Commands

To run MavensMate commands, use the Atom command palette (on OSX: command + shift + p) or use the MavensMate menu in Atom.