update README
This commit is contained in:
parent
a4098ce5b1
commit
ff27d387b1
1 changed files with 13 additions and 13 deletions
26
README.md
26
README.md
|
@ -1,48 +1,48 @@
|
|||
# Variable Time
|
||||
|
||||
## instructions
|
||||
## Instructions
|
||||
Instructions on how to use Variable Time are available [here](https://git.pointer.click/variablelab/variabletime/wiki)
|
||||
|
||||
## issues
|
||||
If you have issues with Variable Time, please write us at `variabletime at pointer.click`.
|
||||
## Issues
|
||||
If you experience issues with Variable Time, please write us at `variabletime at pointer.click`.
|
||||
|
||||
## run
|
||||
## Run
|
||||
Though it is possible to run this on your own server, we expect that you will probably just want to visit [variable time](https://variabletime.pointer.click)
|
||||
|
||||
Should you not be afraid to dive into the mysterious world of developing Variable Time, please go ahead.
|
||||
|
||||
### compile and run
|
||||
### Compile and run
|
||||
Install all dependencies, then
|
||||
|
||||
`$ emmake make && python3 serve.py`
|
||||
|
||||
## dependencies
|
||||
### depends on:
|
||||
## Dependencies
|
||||
### Depends on:
|
||||
- [openFrameworks 0.12.0](https://openframeworks.cc)
|
||||
- [ofxVariableLab](https://git.pointer.click/variablelab/ofxvariablelab)
|
||||
- [ofxMsdfgen](https://git.pointer.click/ofxAddons/ofxmsdfgen)
|
||||
- [ofxGPUFont](https://git.pointer.click/ofxAddons/ofxgpufont)
|
||||
- [Emscripten SDK](https://github.com/emscripten-core/emsdk)
|
||||
|
||||
### optional:
|
||||
### Optional:
|
||||
- [ofxProfiler](https://git.pointer.click/ofxAddons/ofxProfiler)
|
||||
|
||||
### included dependencies:
|
||||
### Included dependencies:
|
||||
- [ffmpeg.wasm](https://github.com/ffmpegwasm/ffmpeg.wasm)
|
||||
- [theatre-js](https://git.pointer.click/variablelab/theatre)
|
||||
we use a custom fork of [theatre-js](https://theatrejs.com), which is a fantastic animation library and framework
|
||||
- [miniz](https://github.com/richgel999/miniz)
|
||||
- [emscripten-browser-file](https://github.com/Armchair-Software/emscripten-browser-file)
|
||||
|
||||
## development notes:
|
||||
### https local development
|
||||
## Development notes:
|
||||
### Https local development
|
||||
- install [mkcert](https://github.com/FiloSottile/mkcert)
|
||||
- follow instructions and install certificate file in bin/ssl
|
||||
|
||||
### convenience scripts
|
||||
### Convenience scripts
|
||||
`$ ./lightclean.sh && emmake make -j$(nproc) && python3 serve.py`
|
||||
|
||||
Note: As we load shaders from external repositories, they need to be copied to the data directory before emscripten compilation. This happens automatically if we delete them first.
|
||||
|
||||
### fonts
|
||||
### Fonts
|
||||
Fonts have different licensing and are not included in this repository.
|
||||
|
|
Loading…
Reference in a new issue