Skip to content

Commit

Permalink
First pass at cleaning up the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
grantjbutler committed Jan 31, 2022
1 parent fa0e93f commit f2fe8f9
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
# obs-layout

## Project setup
```
yarn install
```
We're trying to figure out a good name. If you have an idea or suggestion, please [let us know](https://github.com/grantjbutler/obs-layout/issues/17)!

### Compiles and hot-reloads for development
```
yarn serve
```
`obs-layout` is a tool for creating complex layouts in OBS without the need to manually size and position them. It provides a flexbox-like system for calculating layouts, and then syncs them over to scenes in OBS.

### Compiles and minifies for production
```
yarn build
```
## Installation

### Lints and fixes files
```
yarn lint
```
In the future, full builds of this app will be available as Releases. However, as this project is still early in its lifecycle, you must build the app from source yourself.

### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
## Building

obs-layout is an Electron app that uses nklayman/vue-cli-plugin-electron-builder for building. This assumes you have the [Vue CLI](https://cli.vuejs.org) installed, as well as added the electron-build plugin by running `vue add electron-builder`.

With the electron-builder plugin installed, you can run `yarn electron:serve` to compile and launch the app.

0 comments on commit f2fe8f9

Please sign in to comment.