# MuD Notes
An Electron-powered, CommonMarkl-based note-taking app.


## Using MuD Notes
Currently, MuD Notes requires that you have [Electron](http://electron.atom.io) pre-installed on your system to run (if you don't already have it). To run MuD Notes:

1. Download the zip folder containing the Master branch and unpack it into your desired location.
2. Open a terminal or command prompt and navigate to the directory **above** where you unzipped MuD Notes.

  - e.g., if you unpacked it to `{%USER%}/Downloads/MuD-Notes`, you would cd to `{%USER%}/Downloads`

3. Assuming you installed the pre-built binary packages for Electron, type `electron ./MuD-Notes` to run the program.

  - *Note:* If this step does not work, locate the path to Electron. Often, simply running Electron will show you the exact path to the pre-built binary file. The [Electron docs](https://github.com/atom/electron/tree/master/docs) page should have information on exactly where this is installed by default.
    - I will change the Electron docs link above once I find a hard-link to the page containing that information.

# MuD Notes
An Electron-powered, CommonMark-based note-taking app.


## Using MuD Notes
Currently, MuD Notes requires that you have [Electron](http://electron.atom.io) pre-installed on your system to run (if you don't already have it). To run MuD Notes:

1. Download the zip folder containing the Master branch and unpack it into your desired location.
2. Open a terminal or command prompt and navigate to the directory **above** where you unzipped MuD Notes.

  - e.g., if you unpacked it to `{%USER%}/Downloads/MuD-Notes`, you would cd to `{%USER%}/Downloads`

3. Assuming you installed the pre-built binary packages for Electron, type `electron ./MuD-Notes` to run the program.

  - *Note:* If this step does not work, locate the path to Electron. Often, simply running Electron will show you the exact path to the pre-built binary file. The [Electron docs](https://github.com/atom/electron/tree/master/docs) page should have information on exactly where this is installed by default.
    - I will change the Electron docs link above once I find a hard-link to the page containing that information.

Revert "Updated readme to contain run info."
Revert "Updated readme to contain run info."

This reverts commit 64e2178418c332d9559bfc3f020a90882ceb7741.
