Skip to content

Commit a893eb9

Browse files
committed
Update to readme to cover reader conditionals and new docker dev env.
1 parent a457b14 commit a893eb9

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

README.md

+10-21
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A simple and lightweight Entity Component System library for writing games with Clojure or ClojureScript.
44

5-
![Clojars Version](https://clojars.org/brute/latest-version.svg?v=2)
5+
![Clojars Version](https://clojars.org/brute/latest-version.svg?v=3)
66

77
[![wercker status](https://app.wercker.com/status/5f5d692036ee110c41a50ccc7b6f4ae5/m "wercker status")](https://app.wercker.com/project/bykey/5f5d692036ee110c41a50ccc7b6f4ae5)
88

@@ -140,32 +140,21 @@ Pull requests are always welcome!
140140

141141
Active development happens on the `develop` branch. The `master` branch is the source for the current release.
142142

143-
### CLJX
144-
This project uses [CLJX](https://github.com/lynaghk/cljx) to cross compile to Clojure and ClojureScript. For that reason, you will want to run `lein cljx` before starting up a REPL, otherwise the REPL won't be able to find the user.clj dependencies.
143+
### Reader Conditionals
144+
This project uses [Reader Conditionals](http://clojure.org/reader#The%20Reader--Reader%20Conditionals) to support both Clojure and ClojureScript. It should be a seamless experience.
145145

146-
If you want to use [Midje autotest](https://github.com/marick/Midje/wiki/Autotest), you will want to run `lein cljx auto` to automatically generate the Clojure files so that Midje can see the changes.
146+
## Testing
147147

148-
### ClojureScript
148+
To test under Clojure: `lein test`
149149

150-
To run the tests under ClojureScript you will need the following Node pages installed:
150+
To test under ClojureScript: `lein cljstest`
151151

152-
```bash
153-
npm install -g karma karma-cli karma-jasmine jasmine-node
154-
```
155-
156-
To run the CLJS tests in isolation you can run:
157-
158-
```bash
159-
lein cljsbuild test karma
160-
```
161-
162-
### Clean Test
152+
To run all tests: `lein alltest`
163153

164-
To do a clean end to end test of both the Clojure and ClojureScript code:
154+
### Run all tests in the a Docker Container
155+
You should be able to run all the tests without having to install anything, except to pull the Docker container.
165156

166-
```bash
167-
lein cleantest
168-
```
157+
`make test` will run all the tests in the development Docker container, which should make development easier.
169158

170159
## License
171160

0 commit comments

Comments
 (0)