-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs; Update README and add example outputs.
- Loading branch information
Oliver Hofkens
committed
Apr 3, 2020
1 parent
2caf331
commit f095295
Showing
3 changed files
with
106 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
Oops, something went wrong.