Commit 76b64ade authored by Dan Wilcox's avatar Dan Wilcox
Browse files

updated readme to reflect changes in practice when developing ofxTensorflow2, added changelog

parent b3e98fd8
// TODO: please fill me
# Python
__pycache__
......
0.1.0: 2021 Jan 01
* fixed issue A
* added feature B
* uppated thing C
* removed widget D
## Our Pledge
We as community leaders, artists, curators and contributors pledge to make participation in our community and exhibtions a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
We as community leaders, artists, curators and contributors pledge to make
participation in our community and exhibtions a harassment-free experience for
everyone, regardless of age, body size, visible or invisible disability,
ethnicity, sex characteristics, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
......
# Repo Name
"Short Description WHAT is it doing?"
This code base has been developed by [ZKM | Hertz-Lab](https://zkm.de/en/about-the-zkm/organization/hertz-lab) as part of the project [»The Intelligent Museum«](#the-intelligent-museum).
Please raise issues, ask questions, throw in ideas or submit code, as this repository is intended to be an open platform to collaboratively improve "TOPIC NAME"
Project Name
============
_Project overview image here, if possible_
_Short, one to two line project description._
This code has been developed by [ZKM | Hertz-Lab](https://zkm.de/en/about-the-zkm/organization/hertz-lab) as part of the project [»The Intelligent Museum«](#the-intelligent-museum).
Copyright (c) 2021 ZKM | Karlsruhe.
Copyright (c) 2021 Artist Developer.
For information on usage and redistribution, and for a DISCLAIMER OF ALL
WARRANTIES, see the file, "LICENSE.txt," in this distribution.
BSD Simplified License.
### Target Platform
Tested under Ubuntu 18.04 using python 3.7 and tensorflow 2.3
Description
-----------
### Features
* can do this and that
* achieves blablabla
_Detailed project description. Don't forget to include relevant attribution for forked, adapted, or inspired projects._
### Structure
* folder1/: does that
* folder2/: has this
### Installation
_List repo folder structure for larger, more complicated projects_
* folder1/: contains models
* folder2/: contains media assets
* etc...
Requirements
------------
(Software) dependencies:
* libA
* libB
* etc...
Operating systems/platforms:
* macOS
* Linux
* Windows
* etc...
_Add any notes about which platforms or setups were used for development & testing._
Installation & Build
--------------------
_General dependency & build install instructions with per-platform subsections when needed. Please include commandline steps, when applicable._
Download and Install [Anaconda](https://www.anaconda.com/products/individual). Afterwards create a virtual environment:
```
```shell
$ conda create -n "name" python=3.7
$ conda activate "name"
$ pip install -r requirements.txt
```
#### Additional Software
```
$ sudo apt install howaboutthat
```
Usage
-----
_Usage instructions for when the application is built and installed._
### Usage
##### show help
#### Show Help
```
$ python executable.py --help
```
##### scenario 1
#### scenario 1
```
$ python executable.py --parameter 42
```
### Further Reading
References / Further Reading
----------------------------
_List useful references, related projects, or papers here._
* [paper](www.google.com)
* [paper2](www.google.com)
### Contribute
Contributions are very welcome!
Please send an email to author@zkm.de
Contribute
----------
Contributions are very welcome! Clone or fork the repo, then request a pull / merge.
If you find any bugs or suggestions please log them here as well.
The Intelligent Museum
----------------------
### The Intelligent Museum
An artistic-curatorial field of experimentation for deep learning and visitor participation
The [ZKM | Center for Art and Media](https://zkm.de/en) and the [Deutsches Museum Nuremberg](https://www.deutsches-museum.de/en/nuernberg/information/) cooperate with the goal of implementing an AI-supported exhibition. Together with researchers and international artists, new AI-based works of art will be realized during the next four years (2020-2023). They will be embedded in the AI-supported exhibition in both houses. The Project „The Intelligent Museum“ is funded by the Digital Culture Programme of the [Kulturstiftung des Bundes](https://www.kulturstiftung-des-bundes.de/en) (German Federal Cultural Foundation).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment