From 250cad6dabd9d721cd02a4f100c2dc822c110eb4 Mon Sep 17 00:00:00 2001 From: Will Stensvold Date: Mon, 8 Dec 2025 11:19:55 -0600 Subject: [PATCH] Adding an MIT license and updating the README --- LICENSE | 15 +++++++++++++++ README.md | 49 ++++++++++++++++++------------------------------- 2 files changed, 33 insertions(+), 31 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..12c27ee --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ + + +MIT License + +Copyright (c) 2025 Sludge & Friends LLC + +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 (including the next paragraph) 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. +Standard License Header + +There is no standard license header for the license + diff --git a/README.md b/README.md index 75842c4..2bc9017 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,25 @@ -# sv +# On The Spectrum - A party game to argue with friends about -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +## Building project -## Creating a project +Preliminary steps: -If you're seeing this, you've probably already done this step. Congrats! +- Get [Bun](https://bun.com/docs/installation) `curl -fsSL https://bun.com/install | bash` +- Maybe need [Node](https://nodejs.org/en/download) too? +- IDK. I'm also using [Jujitsu](https://docs.jj-vcs.dev/latest/) but you don't have to. +- Ask me if you have questions +- You'll also prolly have to get ssh keys to push but idk. ```sh -# create a new project in the current directory -npx sv create +# git clone the directory +git clone git@git.sr.ht:~svlad_cjelli/onTheSpectrum -# create a new project in my-app -npx sv create my-app +# cd into directory +cd onTheSpectrum + +# bun install all dependencies +bun i + +# bun run with bun backend +bun --bun run dev --open ``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: - -```sh -npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` - -## Building - -To create a production version of your app: - -```sh -npm run build -``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.