chore: name update and readme update

This commit is contained in:
pskfyi 2022-01-06 01:23:15 -08:00 committed by pskfyi
parent d559475c67
commit daabaf2174
3 changed files with 11 additions and 55 deletions

View File

@ -1,6 +1,10 @@
# yarny-prototype # Timekeeper
## Build Setup An incremental game created for [New Years Incremental Game Jam 2022](https://itch.io/jam/new-years-incremental-game-jam).
## Getting Started
With [Volta](https://volta.sh/) installed:
```bash ```bash
# install dependencies # install dependencies
@ -9,60 +13,12 @@ $ yarn install
# serve with hot reload at localhost:3000 # serve with hot reload at localhost:3000
$ yarn dev $ yarn dev
# build for production and launch server
$ yarn build
$ yarn start
# generate static project # generate static project
$ yarn generate $ yarn generate
``` ```
For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org). For detailed explanation on how things work, check out the .
## Special Directories ## Architecture
You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality. A single-page web app made with [Nuxt](https://nuxtjs.org) (a [Vue](https://vuejs.org/) app framework) and [Tailwind](https://tailwindcss.com/)
### `assets`
The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).
### `components`
The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).
### `layouts`
Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).
### `pages`
This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).
### `plugins`
The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).
### `static`
This directory contains your static files. Each file inside this directory is mapped to `/`.
Example: `/static/robots.txt` is mapped as `/robots.txt`.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).
### `store`
This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.
More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).

View File

@ -4,7 +4,7 @@ export default {
// Global page headers: https://go.nuxtjs.dev/config-head // Global page headers: https://go.nuxtjs.dev/config-head
head: { head: {
title: 'yarny-prototype', title: 'Timekeeper',
meta: [ meta: [
{ charset: 'utf-8' }, { charset: 'utf-8' },
{ name: 'viewport', content: 'width=device-width, initial-scale=1' }, { name: 'viewport', content: 'width=device-width, initial-scale=1' },

View File

@ -1,5 +1,5 @@
{ {
"name": "gamejam-prototype", "name": "timekeeper",
"version": "1.0.0", "version": "1.0.0",
"private": true, "private": true,
"scripts": { "scripts": {