variablelab/variabletime
variablelab/variabletime
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update README

Browse source
This commit is contained in:
jrkb 2023-09-24 21:51:33 +02:00
parent a4098ce5b1
commit ff27d387b1
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,48 +1,48 @@
# Variable Time # Variable Time
## instructions ## Instructions
Instructions on how to use Variable Time are available [here](https://git.pointer.click/variablelab/variabletime/wiki) Instructions on how to use Variable Time are available [here](https://git.pointer.click/variablelab/variabletime/wiki)
## issues ## Issues
If you have issues with Variable Time, please write us at `variabletime at pointer.click`. 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) 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. 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 Install all dependencies, then
`$ emmake make && python3 serve.py` `$ emmake make && python3 serve.py`
## dependencies ## Dependencies
### depends on: ### Depends on:
- [openFrameworks 0.12.0](https://openframeworks.cc) - [openFrameworks 0.12.0](https://openframeworks.cc)
- [ofxVariableLab](https://git.pointer.click/variablelab/ofxvariablelab) - [ofxVariableLab](https://git.pointer.click/variablelab/ofxvariablelab)
- [ofxMsdfgen](https://git.pointer.click/ofxAddons/ofxmsdfgen) - [ofxMsdfgen](https://git.pointer.click/ofxAddons/ofxmsdfgen)
- [ofxGPUFont](https://git.pointer.click/ofxAddons/ofxgpufont) - [ofxGPUFont](https://git.pointer.click/ofxAddons/ofxgpufont)
- [Emscripten SDK](https://github.com/emscripten-core/emsdk) - [Emscripten SDK](https://github.com/emscripten-core/emsdk)
### optional: ### Optional:
- [ofxProfiler](https://git.pointer.click/ofxAddons/ofxProfiler) - [ofxProfiler](https://git.pointer.click/ofxAddons/ofxProfiler)
### included dependencies: ### Included dependencies:
- [ffmpeg.wasm](https://github.com/ffmpegwasm/ffmpeg.wasm) - [ffmpeg.wasm](https://github.com/ffmpegwasm/ffmpeg.wasm)
- [theatre-js](https://git.pointer.click/variablelab/theatre) - [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 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) - [miniz](https://github.com/richgel999/miniz)
- [emscripten-browser-file](https://github.com/Armchair-Software/emscripten-browser-file) - [emscripten-browser-file](https://github.com/Armchair-Software/emscripten-browser-file)
## development notes: ## Development notes:
### https local development ### Https local development
- install [mkcert](https://github.com/FiloSottile/mkcert) - install [mkcert](https://github.com/FiloSottile/mkcert)
- follow instructions and install certificate file in bin/ssl - follow instructions and install certificate file in bin/ssl
### convenience scripts ### Convenience scripts
`$ ./lightclean.sh && emmake make -j$(nproc) && python3 serve.py` `$ ./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. 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. Fonts have different licensing and are not included in this repository.