Skip to content

Commit

Permalink
Docs; Update README and add example outputs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Hofkens committed Apr 3, 2020
1 parent 2caf331 commit f095295
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
# Generative Art
# genart

Generative art playground
Generative art experiments

## Installation

* Run `pip install genart` or `pipenv install genart`
* Clone the repository
* `cd` to the repository
* Run `pipenv install` or `pipenv install --dev` if you're planning on developing (or install with the python dependency manager of your choice if you know what you're doing.)


## Usage

See `genart --help`
Run `genart --help` to get a list of available commands and experiments.


## Development
## Experiments

- Bubble Chammber
<img src="docs/assets/bubblechamber_1.svg" width="800px" />


### Environment Setup
- Wael
<img src="docs/assets/wael_1.png", width="800px" />

* Clone this repository
* `cd genart`
* Run `pipenv install --dev`

## Development

### Tests & Linting

* Run `make lint` to run linting and type checking.
* Run `make test` to run tests.
* Run `pipenv run tox` to do the above in dedicated environments and across all configured Python versions.

Loading

0 comments on commit f095295

Please sign in to comment.