Skip to content

Commit

Permalink
Add proper README
Browse files Browse the repository at this point in the history
  • Loading branch information
MrEbbinghaus committed Mar 9, 2020
1 parent fb48a44 commit 26384d7
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.github/resources filter=lfs diff=lfs merge=lfs -text
Binary file added .github/resources/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 17 additions & 6 deletions README.md → README.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
# biosphere
:imagesdir: .github/resources

A Quil sketch designed to ... well, that part is up to you.
= Biosphere

## Usage
The Repo will grow a simulated eco system where agents will adapt to survive and prosper.

image::screenshot.png[align="center"]

== Goals

- [x] Implement basic world generation.
- [ ] Implement basic _laws of nature_
- [ ] Develop feature set for creatures
- [ ] Look into and implement https://towardsdatascience.com/neat-an-awesome-approach-to-neuroevolution-3eca5cc7930f[NEAT]

== Usage

Run `lein figwheel` in your terminal. Wait for a while until you see `Successfully compiled "resources/public/js/main.js"`. Open [localhost:3449](http://localhost:3449) in your browser.

You can use this while developing your sketch. Whenever you save your source files the browser will automatically refresh everything, providing you with quick feedback. For more information about Figwheel, check the [Figwheel repository on GitHub](https://github.com/bhauman/lein-figwheel).

## Publishing your sketch
== Publishing your sketch

Before you publish your sketch, run `lein do clean, cljsbuild once optimized`. This will compile your code and run Google Closure Compiler with advanced optimizations. Take `resources/public/index.html` and `resources/public/js/main.js` and upload them to server of your choice.

## License
== License

Copyright © 2017 FIXME
Copyright © 2020 Björn Ebbinghaus

Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.

0 comments on commit 26384d7

Please sign in to comment.