1
0
Fork 0
mirror of https://github.com/documize/community.git synced 2025-08-07 22:45:24 +02:00

Modify README.md in light of Enes setup issues

This commit is contained in:
Elliott Stoneham 2016-06-14 16:05:14 +01:00
parent b7f22edb80
commit b5a0fbdd7e

View file

@ -12,17 +12,25 @@ You can operate outside the AGPL restrictions by purchasing Documize Enterprise
## Running Documize for the first time ## Running Documize for the first time
Although the Documize binaries run on Linux, Windows and OSX, the build process has only been tested on OSX. Although the Documize binaries run on Linux, Windows and macOS, the build process has only been tested on macOS.
Install the prerequisites: Install the prerequisites:
* Go from https://golang.org (be careful to set the $GOPATH environment variable correctly, you may find https://www.goinggo.net/2016/05/installing-go-and-your-workspace.html helpful) * Go from https://golang.org (be careful to set the $GOPATH environment variable correctly, you may find https://www.goinggo.net/2016/05/installing-go-and-your-workspace.html helpful)
* NPM from https://www.npmjs.com * NPM from https://www.npmjs.com
* Ember from http://emberjs.com/ * Ember from http://emberjs.com/
* MySQL (v10.7+) from http://dev.mysql.com/downloads/mysql/ * Bower from https://bower.io/
* MySQL (v10.7+) from http://dev.mysql.com/downloads/mysql/ (don't forget to copy the one-time password and your system may require a restart)
Make sure this repository sits at the following position relative to your $GOPATH: $GOPATH/src/github.com/documize/community Make sure this repository sits at the following position relative to your $GOPATH: $GOPATH/src/github.com/documize/community
After cloning the repository in the above location, go there and run: ./build.sh After cloning the repository in the above location, go there and run:
```
cd app
npm install
bower install
cd ..
./build.sh
```
The build script packages up the Ember JS/HTML/CSS code for production use, then generates Go code that creates a simple in-memory file system to contain it. That generated Go code is compiled with the rest to produce a single binary for each of the target systems. The build script packages up the Ember JS/HTML/CSS code for production use, then generates Go code that creates a simple in-memory file system to contain it. That generated Go code is compiled with the rest to produce a single binary for each of the target systems.