creates video voice memos from audio clips; with bluesky integration. trill.ptr.pet

docs: add license and readme

ptr.pet 050be2bc dbd37d3f

verified
Changed files
+35 -26
+16
LICENSE
··· 1 + Copyright (c) 2025 Yusuf Bera Ertan <dawn@mm.st> 2 + 3 + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 4 + associated documentation files (the "Software"), to deal in the Software without restriction, including 5 + without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 6 + copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to 7 + the following conditions: 8 + 9 + The above copyright notice and this permission notice shall be included in all copies or substantial 10 + portions of the Software. 11 + 12 + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 13 + LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 14 + NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 15 + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 16 + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+19 -26
README.md
··· 1 - ## Usage 1 + ## trill 2 2 3 - Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. 3 + a webapp that converts voice memos into videos, ready for posting on bluesky (or perhaps elsewhere!). 4 + it lets you upload audio files or record directly from the microphone, and automatically generates a 5 + video using your profile picture. 4 6 5 - This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template. 7 + built with [solidjs](https://solidjs.com) and vite. uses [park-ui](https://park-ui.com) for components and [atcute](https://tangled.org/mary.my.id/atcute) for atproto interactions. 6 8 7 - ```bash 8 - $ npm install # or pnpm install or yarn install 9 - ``` 9 + ### usage 10 10 11 - ### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) 11 + 1. upload a voice memo or record one. 12 + 2. it will automatically be converted to a video. 13 + 3. (optional) add an account to enable bluesky integration. 12 14 13 - ## Available Scripts 15 + ### running 14 16 15 - In the project directory, you can run: 17 + #### with nix 16 18 17 - ### `npm run dev` or `npm start` 19 + - build the project: `nix build .#memos` 20 + - enter the dev shell: `nix develop` 18 21 19 - Runs the app in the development mode.<br> 20 - Open [http://localhost:3000](http://localhost:3000) to view it in the browser. 21 - 22 - The page will reload if you make edits.<br> 23 - 24 - ### `npm run build` 25 - 26 - Builds the app for production to the `dist` folder.<br> 27 - It correctly bundles Solid in production mode and optimizes the build for the best performance. 28 - 29 - The build is minified and the filenames include the hashes.<br> 30 - Your app is ready to be deployed! 22 + #### manually 31 23 32 - ## Deployment 24 + you'll need deno. 33 25 34 - You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) 35 - 36 - ## This project was created with the [Solid CLI](https://github.com/solidjs-community/solid-cli) 26 + ```bash 27 + deno install && panda codegen 28 + deno task dev # or deno task build 29 + ```