Skip to content

Commit 72fd3ec

Browse files
committed
update readme
1 parent 3a2125a commit 72fd3ec

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Openframe controller is the software that runs on the frame itself (i.e. the
66

77
The block diagram below represents a proposed architecture for the Openframe platform. It will continue to evolve as development on the project progresses.
88

9-
![alt tag](https://raw.github.com/OpenframeProject/Openframe-APIServer/restify/docs/img/API Diagram.jpg)
9+
![alt tag](https://raw.githubusercontent.com/OpenframeProject/openframeproject.github.io/master/img/API%20Diagram%20v3.jpg)
1010

1111
#### Modules
1212

@@ -34,6 +34,12 @@ $ npm start
3434

3535
Upon startup, the application will prompt you for your Openframe username and password, and a name for this frame. You can run this on a mac or linux machine (windows untested), though various artwork format extensions are likely to be developed with a specific target platform in mind.
3636

37+
For DEBUG output, set the DEBUG env var:
38+
39+
```bash
40+
$ DEBUG=* npm start
41+
```
42+
3743
### Configuration files
3844

3945
When you run `npm install`, the `install.sh` script will be executed. This script creates a hidden directory, `.openframe`, in your user home folder (/home/{username}/.openframe), and copies the default `.ofrc`configuration file there. The `.ofrc` file contains the server settings — by default this will point to the hosted API server at openframe.io, but if you're running a local server for development or are hosting your own API server you can update the settings in `.ofrc` accordingly.

0 commit comments

Comments
 (0)