Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Commit

Permalink
docs: added docs for GUI
Browse files Browse the repository at this point in the history
  • Loading branch information
nysos3 committed Mar 7, 2019
1 parent bcf9ff3 commit c6f5405
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 47 deletions.
18 changes: 9 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,40 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

<a name="2.0.0"></a>
# [2.0.0](https://github.com/nysos3/airforsteam-cli/compare/v2.0.0-0...v2.0.0) (2019-03-07)
# [2.0.0](https://github.com/nysos3/airforsteam-config/compare/v2.0.0-0...v2.0.0) (2019-03-07)


### Bug Fixes

* **gui:** fix skin installation ([8e2a2b9](https://github.com/nysos3/airforsteam-cli/commit/8e2a2b9))
* **gui:** fix skin installation ([8e2a2b9](https://github.com/nysos3/airforsteam-config/commit/8e2a2b9))



<a name="2.0.0-0"></a>
# [2.0.0-0](https://github.com/nysos3/airforsteam-cli/compare/v1.1.0...v2.0.0-0) (2019-03-07)
# [2.0.0-0](https://github.com/nysos3/airforsteam-config/compare/v1.1.0...v2.0.0-0) (2019-03-07)


### Features

* **gui:** initial version of a GUI for configuration ([cb16ed4](https://github.com/nysos3/airforsteam-cli/commit/cb16ed4))
* **gui:** initial version of a GUI for configuration ([cb16ed4](https://github.com/nysos3/airforsteam-config/commit/cb16ed4))



<a name="1.1.0"></a>
# [1.1.0](https://github.com/nysos3/airforsteam-cli/compare/v1.0.1...v1.1.0) (2019-02-23)
# [1.1.0](https://github.com/nysos3/airforsteam-config/compare/v1.0.1...v1.1.0) (2019-02-23)


### Bug Fixes

* **configure:** fix windows detection for default Steam skin path ([c8ed2b4](https://github.com/nysos3/airforsteam-cli/commit/c8ed2b4))
* **font-helper:** temp fix broken windows detection ([146b18f](https://github.com/nysos3/airforsteam-cli/commit/146b18f))
* **configure:** fix windows detection for default Steam skin path ([c8ed2b4](https://github.com/nysos3/airforsteam-config/commit/c8ed2b4))
* **font-helper:** temp fix broken windows detection ([146b18f](https://github.com/nysos3/airforsteam-config/commit/146b18f))



<a name="1.0.1"></a>
## [1.0.1](https://github.com/nysos3/airforsteam-cli/compare/v1.0.0...v1.0.1) (2019-02-23)
## [1.0.1](https://github.com/nysos3/airforsteam-config/compare/v1.0.0...v1.0.1) (2019-02-23)


### Bug Fixes

* expose bin in package.json ([80a69e1](https://github.com/nysos3/airforsteam-cli/commit/80a69e1))
* expose bin in package.json ([80a69e1](https://github.com/nysos3/airforsteam-config/commit/80a69e1))
61 changes: 61 additions & 0 deletions README.CLI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# airforsteam-config
[![NPM version](https://badge.fury.io/js/airforsteam.svg)](http://badge.fury.io/js/airforsteam)
[![Dependency Status](https://img.shields.io/david/nysos3/airforsteam-config.svg)](https://david-dm.org/nysos3/airforsteam-config)
[![npm](https://img.shields.io/npm/dm/airforsteam.svg?maxAge=2592000)](https://www.npmjs.com/package/airforsteam)

> An unofficial Air-for-Steam CLI with interactive configuration and updating of the Air-for-Steam skin
> For GUI usage, please see [README.md](https://github.com/nysos3/airforsteam-config/blob/master/README.md).
<img width="800" alt="airforsteam-config" src="https://github.com/nysos3/airforsteam-config/blob/master/assets/showcase.gif?raw=true">

#### Why?
I got tired of applying my desired theme options after each update of the skin.

Also, copying files on mac is awful.

## Requirements
[Node](https://nodejs.org/en/)

#### Windows
Windows users may also need to run the following from an elevated command prompt.
It is entirely possible that you may not need this step. For more information, see [here](https://www.npmjs.com/package/windows-build-tools).
```bash
npm install -g --production windows-build-tools
```

#### macOS
Honestly, as far as I'm aware this tool should work out of the box. If you run into issues running or installing this tool on macOS, please [open an issue](https://github.com/nysos3/airforsteam-config/issues) and provide details so that I may update this readme.

#### Linux
On Linux, you also may need to install the libfontconfig-dev package, for example:
```bash
sudo apt-get install libfontconfig-dev
```

## Install
```bash
npm i -g airforsteam
```

## Run
```bash
npx airforsteam
```

Available options may be viewed by running the help command.
```bash
npx airforsteam --help
```

## Credits
- Clearly, credits to the team behind [Air for Steam](https://github.com/airforsteam/Air-for-Steam)
- [dylang](dylang)'s [npm-check](https://github.com/dylang/npm-check/) for inspiration into best practices for CLI development, as this is my first public/polished CLI.

## TODO
- Test Windows more extensively

## License
Yeah, I don't pretend to understand legalese, so I've mimicked the same license, CC-BY-NC-4.0, used by [Air for Steam](https://github.com/airforsteam/Air-for-Steam/blob/813c437397f75f79672f29b98cce2741b3fa351e/LICENSE.txt)

Screenshots are [CC BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)
46 changes: 12 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,35 @@
# airforsteam-cli
# airforsteam-config
[![NPM version](https://badge.fury.io/js/airforsteam.svg)](http://badge.fury.io/js/airforsteam)
[![Dependency Status](https://img.shields.io/david/nysos3/airforsteam-cli.svg)](https://david-dm.org/nysos3/airforsteam-cli)
[![Dependency Status](https://img.shields.io/david/nysos3/airforsteam-config.svg)](https://david-dm.org/nysos3/airforsteam-config)
[![npm](https://img.shields.io/npm/dm/airforsteam.svg?maxAge=2592000)](https://www.npmjs.com/package/airforsteam)

> An unofficial Air-for-Steam CLI with interactive configuration and updating of the Air-for-Steam skin
<img width="800" alt="airforsteam-cli" src="https://github.com/nysos3/airforsteam-cli/blob/master/assets/showcase.gif?raw=true">
> For CLI usage, please see [README.CLI.md](https://github.com/nysos3/airforsteam-config/blob/master/README.CLI.md).
<img width="800" alt="airforsteam-config" src="https://github.com/nysos3/airforsteam-config/blob/master/assets/gui.png?raw=true">

#### Why?
I got tired of applying my desired theme options after each update of the skin.

Also, copying files on mac is awful.

## Requirements
[Node](https://nodejs.org/en/)
## Download
[View Releases](https://github.com/nysos3/airforsteam-config/releases/latest)

#### Windows
Windows users may also need to run the following from an elevated command prompt.
It is entirely possible that you may not need this step. For more information, see [here](https://www.npmjs.com/package/windows-build-tools).
```bash
npm install -g --production windows-build-tools
```
Download and run airforsteam.Setup.X.X.X.exe

#### macOS
Honestly, as far as I'm aware this tool should work out of the box. If you run into issues running or installing this tool on macOS, please [open an issue](https://github.com/nysos3/airforsteam-cli/issues) and provide details so that I may update this readme.
Download airforsteam-X.X.X.dmg or airforsteam-X.X.X-mac.zip

#### Linux
On Linux, you also may need to install the libfontconfig-dev package, for example:
```bash
sudo apt-get install libfontconfig-dev
```

## Install
```bash
npm i -g airforsteam
```

## Run
```bash
npx airforsteam
```

Available options may be viewed by running the help command.
```bash
npx airforsteam --help
```
Download airforsteam_X.X.X_amd64.snap
>See [here](https://itsfoss.com/use-snap-packages-ubuntu-16-04/) for details on using a Snap.
## Credits
- Clearly, credits to the team behind [Air for Steam](https://github.com/airforsteam/Air-for-Steam)
- [dylang](dylang)'s [npm-check](https://github.com/dylang/npm-check/) for inspiration into best practices for CLI development, as this is my first public/polished CLI.

## TODO
- Test Windows more extensively
- Built on Vue, Vuetify, Electron, and many others

## License
Yeah, I don't pretend to understand legalese, so I've mimicked the same license, CC-BY-NC-4.0, used by [Air for Steam](https://github.com/airforsteam/Air-for-Steam/blob/813c437397f75f79672f29b98cce2741b3fa351e/LICENSE.txt)
Expand Down
Binary file added assets/gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion lib/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ try {
console.error(chalk.red('[airforsteam] Usually that means that something in the folder structure'))
console.error(chalk.red('[airforsteam] of Air-for-Steam has changed, and this project needs'))
console.error(chalk.red('[airforsteam] to be updated to reflect those changes.'))
console.error(chalk.red('[airforsteam] You can open an issue on GitHub here https://github.com/nysos3/airforsteam-cli/issues'))
console.error(chalk.red('[airforsteam] You can open an issue on GitHub here https://github.com/nysos3/airforsteam-config/issues'))
console.error(chalk.red('[airforsteam] Please supply all output from this run in your issue.'))
} else {
console.error(chalk.red(err.message))
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"name": "airforsteam",
"version": "2.0.0",
"description": "An unofficial Air-for-Steam CLI with interactive configuration and updating of the Air-for-Steam skin",
"homepage": "https://github.com/nysos3/airforsteam-cli",
"homepage": "https://github.com/nysos3/airforsteam-config",
"bugs": {
"url": "https://github.com/nysos3/airforsteam-cli/issues"
"url": "https://github.com/nysos3/airforsteam-config/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/nysos3/airforsteam-cli.git"
"url": "https://github.com/nysos3/airforsteam-config.git"
},
"license": "CC-BY-NC-4.0",
"author": {
Expand Down

0 comments on commit c6f5405

Please sign in to comment.