Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
baku89 committed Oct 4, 2023
1 parent 163cf6f commit c2a1c29
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 4 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# Koma
<div align="center">
<img width="100" src="./public/icon.png" />
<h1>Koma</h1>
<img width="600" src="./screenshot.png" alt="Screenshot of the app" />
</div>

A web-based stop-motion tool based on [Tethr](https://github.com/baku89/tethr), camera controlling library built on WebUSB. Koma (コマ) means “frames” in Japanese, but I'm wondering if there's nicer name for the app.
A open-source stop-motion tool that runs on browsers. It allows you to shoot while tethring usb-connected cameras such as DSLMs, DSLRs, and webcams. Technically, it's bulit upon [Picture Transfer Protocol](https://en.wikipedia.org/wiki/Picture_Transfer_Protocol), [WebUSB API](https://developer.mozilla.org/en-US/docs/Web/API/USB) and its wrapper library [Tethr](https://github.com/baku89/tethr). Note that this project has been developed for my own animation project and is still in early stage of working-in-progress. So it might not work in your environment yet.

FYI, Koma (コマ) means “frames” in Japanese, but I'm wondering if there's nicer name for the app.

## Development

```bash
git clone --recursive https://github.com/baku89/koma
yarn install
yarn dev
```

## Credits

- Sound Effects by [OtoLogic](https://otologic.jp/free/license.html) ([CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/))

```
```
2 changes: 1 addition & 1 deletion dev_modules/tethr
2 changes: 1 addition & 1 deletion dev_modules/tweeq
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c2a1c29

Please sign in to comment.