diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f8e8738 --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +Copyright (c) 2025 Yusuf Bera Ertan + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 7cccc98..92e934c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,29 @@ -## Usage +## trill -Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. +a webapp that converts voice memos into videos, ready for posting on bluesky (or perhaps elsewhere!). +it lets you upload audio files or record directly from the microphone, and automatically generates a +video using your profile picture. -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. +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. -```bash -$ npm install # or pnpm install or yarn install -``` - -### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) - -## Available Scripts - -In the project directory, you can run: +### usage -### `npm run dev` or `npm start` +1. upload a voice memo or record one. +2. it will automatically be converted to a video. +3. (optional) add an account to enable bluesky integration. -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +### running -The page will reload if you make edits.
+#### with nix -### `npm run build` +- build the project: `nix build .#memos` +- enter the dev shell: `nix develop` -Builds the app for production to the `dist` folder.
-It correctly bundles Solid in production mode and optimizes the build for the best performance. +#### manually -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! +you'll need deno. -## Deployment - -You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) - -## This project was created with the [Solid CLI](https://github.com/solidjs-community/solid-cli) +```bash +deno install && panda codegen +deno task dev # or deno task build +```