Navigation Menu

Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
tanner0101 committed Jul 11, 2016
1 parent 0f40508 commit 3ccb060
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 27 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Tanner Nelson

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.
36 changes: 9 additions & 27 deletions README.md
@@ -1,30 +1,12 @@
Learn how to <a href="https://vapor.readme.io/docs/install-cli">install</a> the CLI in Vapor's documentation.
<p align="center">
<img src="https://cloud.githubusercontent.com/assets/1342803/16012068/d98ba914-3155-11e6-8efe-733f35fe67a3.png" width="745" align="middle"/>
</p>

![cjexpzqxeaa0ps9](https://cloud.githubusercontent.com/assets/1342803/16012068/d98ba914-3155-11e6-8efe-733f35fe67a3.png)
# Vapor Toolbox

## Installation instructions (to be moved to https://vapor.readme.io/docs/install-cli)
Learn more about Vapor Toolbox in the <a href="https://vapor.readme.io/docs/install-toolbox">documentation</a>.

Assuming `bootstrap.swift` is being served from `cli.qutheory.io`:

Download installation script:

- `curl -L cli.qutheory.io -o install-vapor.swift`

Run it (installs to `/usr/local/bin/vapor` by default, optionally specify different target):

- `swift install-vapor.swift`

Remove install script:

- `rm install-vapor.swift`

## Extending VaporCLI

If you are using Xcode, everything should be set up in the Xcode project file. It builds and runs the tests.

There is also a script `test` which runs the unit tests on both Darwin (OSX/macOS) and Linux (via docker). It writes the test results to `test.log`, which can be committed to source control.

When added tests, please note that SPM currently requires a few extra steps for them to be picked up by the test runner on Linux:

- in the test case, add a `static var allTests: [(String, (ArrayExtTests) -> () throws -> Void)]` member listing all tests (see existing files for reference)
- in `LinuxMain.swift` add an entry `testCase(YourFileHere.swift)` to `XCTMain`
```sh
# install Vapor Toolbox
curl -sL toolbox.qutheory.io | sh
```

0 comments on commit 3ccb060

Please sign in to comment.