Skip to content

Commit

Permalink
readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Lia-mon committed Dec 21, 2023
1 parent 37761fb commit 894da27
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 29 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Lia Ntikou

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.
39 changes: 10 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,19 @@
# create-svelte
# What is this
A tool to visualize and check chains for the FFBE mobile game

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
# Usage
It is a browser based app, you can try a live version [here](https://lia-mon.github.io/chain/)

## Creating a project
# Building
I used svelte/sveltekit to build this app, nothing particularly special.

If you're seeing this, you've probably already done this step. Congrats!
If you want to build it yourself

```bash
# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app
```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash
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:

```bash
npm install
npm run build
```
I am using the static adapter to generate a static site with added the PWA requirments to try it out.

You can preview the production build with `npm run preview`.
The build will be in the `build` folder ta-dah.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

0 comments on commit 894da27

Please sign in to comment.