Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lnfiniteMonkeys committed Oct 2, 2019
1 parent 54950fd commit f39d1fd
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
#+TITLE: Emacs mode for the TimeLines live coding language
* Installation
Download or ~git-clone~ this repository to a path on your machine and add the
following lines to your ~.emacs~ or ~.emacs.d/init.el~ files:
There are two things here:
1. An Emacs major mode for creating and interacting with a live TimeLines
session.
2. (What I consider to be) A set of sensible default settings and packages to
get someone started with Emacs, together with a mini tutorial.
** Installation
*** Emacs Config
If you are new to Emacs and want to get started quickly, clone this repo using
~git clone https://github.com/lnfiniteMonkeys/TimeLines-emacs.git ~/.emacs.d~
(or if you're on Windows use ~git clone
https://github.com/lnfiniteMonkeys/TimeLines-emacs.git %HOMEPATH%\.emacs.d~
instead).

Make sure there is no ~.emacs~ file left in your home directory, and if you're
on Windows make sure that the ~%HOME%~ environment variable correctly points to
your home. You can set it by running ~setx HOME ^%HOMEDRIVE^%^%HOMEPATH^%~ in a
command prompt.
*** timelines-mode
If you already have an Emacs config and just want to use this mode, clone clone
this repo somewhere on your machine, for example ~git clone https://github.com/lnfiniteMonkeys/TimeLines-emacs.git
~/timelines-emacs~, and add the following lines to your init file, replacing the paths respectively:
#+BEGIN_SRC elisp
(add-to-list 'load-path "~/path/to/timelines-mode")
(require 'timelines-mode)
(load "~/path/to/timelines-mode.el")
(setq timelines-path "~/path/to/timelines/source")
#+END_SRC
replacing the correct paths to timelines-mode (this repo) and the timelines
source (https://github.com/lnfiniteMonkeys/TimeLines).

0 comments on commit f39d1fd

Please sign in to comment.