Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Quick start

aclement edited this page · 8 revisions

Prereqs

You must have node installed. You can grab it from here. We have been testing with various versions from Node 0.8.2 onwards - currently Node 0.8.16 is available and appears to work just fine. Scripted may work with older versions of node, but there is no guarantee (i.e., 0.8.0 is known to be broken).

Getting the code

You can grab the most recent packaged release from here:

Version 0.2.0

Or you can follow the bleeding edge by either cloning the repository:

git clone https://github.com/scripted-editor/scripted

or grabbing a zip of the latest from here (and unzip it):

https://github.com/scripted-editor/scripted/zipball/master

Then add the bin folder to your path:

Mac/Linux:

export PATH=<pathToUnzipLocationOrClone>/bin:$PATH

Win:

set PATH=<pathToUnzipLocationOrClone>\bin;%PATH%

then launch it:

scr myfile.js

(you can use scripted to launch it if you'd prefer to type more characters...)

Anything else I need to know before using it?

When you open Scripted on a file, it will attempt to infer the root of your project by locating the nearest .git/.project file in the hierarchy. Knowing the root is important because that is the scope in which searching and dependency analysis is done. If you don't have one of these markers for the root, you can create an empty .scripted file to indicate the root. Scripted needs to know the root because, of course, some operations (like content assist, dependency resolution, search) happen in the context of a project.

Now go

Just like working with vi or textmate you can fire up scripted simply by launching it from your terminal, specifying the file you want to edit:

Mac/Linux/Windows:

scripted <some_file_for_editing>

Setting up the dev environment

So you are interested in contributing back to the project? Great! Make sure that you have node version 0.8.11 or later installed. Clone the scripted repository make your changes and submit a pull request. We recommend that you use scripted to make your changes. And we ask that you run the tests before submitting any pull requests.

Something went wrong with that request. Please try again.