Skip to content

Commit

Permalink
Update README for beta release
Browse files Browse the repository at this point in the history
Miscellaneous cleanup as well
  • Loading branch information
nasser authored Dec 18, 2018
1 parent 809c6f1 commit a679a29
Showing 1 changed file with 4 additions and 24 deletions.
28 changes: 4 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Arcadia
=======

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/arcadia-unity/Arcadia?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

The integration of the Clojure Programming Language with the Unity 3D game engine.

Status
Expand All @@ -14,30 +15,9 @@ Community
- [Gittr/IRC](https://gitter.im/arcadia-unity/Arcadia)
- [Twitter](https://twitter.com/arcadiaunity)

Installing
----------
The contents of the repository should be copied to a folder named `Arcadia` in any Unity project's Assets folder to enable Clojure. In the future, this will be available from the Asset Store. Once copied, you have access to the REPL and the Clojure compiler.

#### Download Zip File

1. Create a subfolder of your Assets folder named Arcadia
2. [Download](https://github.com/arcadia-unity/Arcadia/archive/develop.zip) our zip file and extract its contents into Arcadia

#### Git Clone

```
cd path/to/unity/project/Assets
git clone https://github.com/arcadia-unity/Arcadia.git
```

Usage
-----
[USAGE.md](https://github.com/arcadia-unity/Arcadia/blob/develop/USAGE.md) us a good place to start, as is the [Wiki](https://github.com/arcadia-unity/Arcadia/wiki). They both cover how to get started and all the prerequisites you'll need. The community on the [Gitter](https://gitter.im/arcadia-unity/Arcadia) is very helpful and happy to answer questions.

### REPL
Arcadia ships with a simple networked REPL that is started automatically or from `Clojure > REPL > Start`. To integrate your text editor with Arcadia, there are a few clients listed on [the Wiki](https://github.com/arcadia-unity/Arcadia/wiki/Resources). Additionally, there are three command line scripts that act as REPL clients if that makes your integration easier. `Editor/repl-client.rb`, `Editor/repl-client.javascript`, and `Infrastructure/repl`. `Infrastructure/repl` is the future, but not totally stable yet. You should try them all and use what works best.

The core devs use the REPL from [Emacs (via Inferior Lisp)](https://github.com/arcadia-unity/arcadia/wiki/Editor-support#emacs) and [SublimeText (via Socket)](https://github.com/nasser/Socket).
Arcadia is documented in our [GitHub wiki](https://github.com/arcadia-unity/Arcadia/wiki). The community on the [Gitter](https://gitter.im/arcadia-unity/Arcadia) is also very helpful and a great place to ask questions.

Contributing
------------
Expand All @@ -55,11 +35,11 @@ You only need to do this once. After that, we can review and merge any contribut

Name
----
This project was originally named "clojure-unity", but was changed to "Arcadia" to avoid infinging on Clojure's trademarks. It was suggested to us by @ztellman at a bar during StrangeLoop 2014, and we are eternally grateful.
This project was [introduced](https://www.youtube.com/watch?v=tJr_TD1BtF0) at Strange Loop 2014 as "clojure-unity". The name "Arcadia" was suggested to us soon after by [@ztellman](https://github.com/ztellman), and we are eternally grateful.

Legal
-----
Copyright © 2014-2017 Tims Gardner, Ramsey Nasser, and [contributors](./CONTRIBUTORS.md).
Copyright © 2014-2019 Tims Gardner, Ramsey Nasser, and [contributors](./CONTRIBUTORS.md).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at

Expand Down

0 comments on commit a679a29

Please sign in to comment.