-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
default ember readme -> CONTRIBUTING.md, screenshots + prose in regul…
…ar README.md
- Loading branch information
Showing
2 changed files
with
67 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # qol-bar-utils | ||
|
|
||
| This README outlines the details of collaborating on this Ember application. | ||
| A short introduction of this app could easily go here. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You will need the following things properly installed on your computer. | ||
|
|
||
| * [Git](https://git-scm.com/) | ||
| * [Node.js](https://nodejs.org/) | ||
| * [Yarn](https://yarnpkg.com/) | ||
| * [Ember CLI](https://ember-cli.com/) | ||
| * [Google Chrome](https://google.com/chrome/) | ||
|
|
||
| ## Installation | ||
|
|
||
| * `git clone <repository-url>` this repository | ||
| * `cd qol-bar-utils` | ||
| * `yarn install` | ||
|
|
||
| ## Running / Development | ||
|
|
||
| * `ember serve` | ||
| * Visit your app at [http://localhost:4200](http://localhost:4200). | ||
| * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). | ||
|
|
||
| ### Code Generators | ||
|
|
||
| Make use of the many generators for code, try `ember help generate` for more details | ||
|
|
||
| ### Running Tests | ||
|
|
||
| * `ember test` | ||
| * `ember test --server` | ||
|
|
||
| ### Linting | ||
|
|
||
| * `yarn lint` | ||
| * `yarn lint:fix` | ||
|
|
||
| ### Building | ||
|
|
||
| * `ember build` (development) | ||
| * `ember build --environment production` (production) | ||
|
|
||
| ### Deploying | ||
|
|
||
| Specify what it takes to deploy your app. | ||
|
|
||
| ## Further Reading / Useful Links | ||
|
|
||
| * [ember.js](https://emberjs.com/) | ||
| * [ember-cli](https://ember-cli.com/) | ||
| * Development Browser Extensions | ||
| * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) | ||
| * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,19 @@ | ||
| # qol-bar-utils | ||
| # [QoL Bar utils](https://qol-bar-utils.netlify.app/) | ||
|
|
||
| This README outlines the details of collaborating on this Ember application. | ||
| A short introduction of this app could easily go here. | ||
| A web app with a set of utilities for encoding, decoding, and generating (from a proprietary declarative schema) config export strings for the [QoL Bar](https://github.com/UnknownX7/QoLBar) plugin for [XIVLauncher](https://github.com/goatcorp/FFXIVQuickLauncher) for FFXIV. | ||
|
|
||
| ## Prerequisites | ||
| <img width="1392" alt="Screenshot 2021-08-25 at 19 41 39" src="https://user-images.githubusercontent.com/7144173/130848238-90659972-66cc-43f3-85d0-ad859fc17277.png"> | ||
|
|
||
| You will need the following things properly installed on your computer. | ||
| <img width="1392" alt="Screenshot 2021-08-25 at 19 41 45" src="https://user-images.githubusercontent.com/7144173/130848247-d65a9406-9e5e-4b6f-9b8f-b8636c62577c.png"> | ||
|
|
||
| * [Git](https://git-scm.com/) | ||
| * [Node.js](https://nodejs.org/) | ||
| * [Yarn](https://yarnpkg.com/) | ||
| * [Ember CLI](https://ember-cli.com/) | ||
| * [Google Chrome](https://google.com/chrome/) | ||
| <img width="1392" alt="Screenshot 2021-08-25 at 19 41 54" src="https://user-images.githubusercontent.com/7144173/130848251-a1b7136a-b405-4ef5-a10b-728614a02152.png"> | ||
|
|
||
| ## Installation | ||
| <img width="1392" alt="Screenshot 2021-08-25 at 19 42 04" src="https://user-images.githubusercontent.com/7144173/130848257-5e391d77-0dfc-4e5c-af40-57784dfb8032.png"> | ||
|
|
||
| * `git clone <repository-url>` this repository | ||
| * `cd qol-bar-utils` | ||
| * `yarn install` | ||
|
|
||
| ## Running / Development | ||
| ### Why does this exist? | ||
| I wanted a way to build the QoL Bar hotbars using a text editor instead of clicking around in game / without needing to relaunch the game after modifying `%appdata%\XIVLauncher\pluginConfigs\QolBar.json`. | ||
|
|
||
| * `ember serve` | ||
| * Visit your app at [http://localhost:4200](http://localhost:4200). | ||
| * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). | ||
| It took way longer to build this than it would have taken to have just done it in game but at least now it's trivially extensible for when new jobs/emotes arrive and the bars need to be updated. Having a way to generate bars programatically is nice too: | ||
|
|
||
| ### Code Generators | ||
|
|
||
| Make use of the many generators for code, try `ember help generate` for more details | ||
|
|
||
| ### Running Tests | ||
|
|
||
| * `ember test` | ||
| * `ember test --server` | ||
|
|
||
| ### Linting | ||
|
|
||
| * `yarn lint` | ||
| * `yarn lint:fix` | ||
|
|
||
| ### Building | ||
|
|
||
| * `ember build` (development) | ||
| * `ember build --environment production` (production) | ||
|
|
||
| ### Deploying | ||
|
|
||
| Specify what it takes to deploy your app. | ||
|
|
||
| ## Further Reading / Useful Links | ||
|
|
||
| * [ember.js](https://emberjs.com/) | ||
| * [ember-cli](https://ember-cli.com/) | ||
| * Development Browser Extensions | ||
| * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) | ||
| * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) | ||
| https://github.com/22a/qol-bar-utils/blob/5c22e098eacfb5ef438582e4b8105ff31728ac49/app/lib/personal-schema.js#L60-L78 |