You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,53 @@ gradle -Pskipbench check # Executes the tests w/o running the benchmarks
111
111
112
112
**Linux Gradle Issues?**[see the wiki here.](https://github.com/numenta/htm.java/wiki/Gradle---JAVA_HOME-Issue-Resolution)
113
113
114
+
115
+
## Reference Build Environment
116
+
As a convenience to developers, we provide a docker image with the needed software to build the HTM.java library from sources. This approach relies on the [Docker Toolbox](https://www.docker.com/products/docker-toolbox), which is installable on Mac and Windows.
117
+
118
+
Below we'll use a technique to share your cloned HTM.java sources from your project folder into a docker container, then build the library with `gradle`. The build outputs are written back to your project folder, not isolated within the container.
119
+
120
+
### Install Docker Toolbox
121
+
Follow the instructions on the toolbox site, then open the quickstart terminal. You should adjust the memory settings on the toolbox VM, because the default (2GB) is insufficient for the HTM.java test suite.
The docker image, which you simply build once, contains OpenJDK 8 and Gradle. It doesn't contain any HTM.java source code; when we later run the container, the source code is read directly from your project folder.
134
+
135
+
```
136
+
[htm.java]$ docker build -t $USER/htm.java .
137
+
...
138
+
Successfully built <IMAGE ID>
139
+
```
140
+
141
+
### Run the Container
142
+
Run a container based on the docker image, which launches a bash shell where you'll fire up gradle.
143
+
144
+
```
145
+
[htm.java]$ docker run -it --rm -v `pwd`:/home/vagrant/htm.java $USER/htm.java
146
+
```
147
+
148
+
Notice that the current directory (which should be your HTM.java project folder) is shared into the container, as `/home/vagrant/htm.java`.
0 commit comments