Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
icy-arctic-fox committed Jun 3, 2019
0 parents commit 5aa4af2
Show file tree
Hide file tree
Showing 9 changed files with 145 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*.cr]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/docs/
/lib/
/bin/
/.shards/
*.dwarf

# Libraries don't need dependency lock
# Dependencies will be locked in applications that use them
/shard.lock
32 changes: 32 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Official language image. Look for the different tagged releases at:
# https://hub.docker.com/r/crystallang/crystal/
image: "crystallang/crystal:latest"

# Cache shards in between builds
cache:
paths:
- lib
- bin

before_script:
- crystal -v # Print out Crystal version for debugging
- shards

spec:
script:
- crystal spec
- bin/ameba
- crystal tool format --check

pages:
stage: deploy
dependencies:
- spec
script:
- crystal docs
- mv docs/ public/
artifacts:
paths:
- public
only:
- master
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Michael Miller

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.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Espresso

Lightweight wrapper around GLFW for Crystal.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
expresso:
gitlab: arctic-fox/espresso
```
2. Run `shards install`

## Usage

```crystal
require "espresso"
```

TODO: Write usage instructions here

## Development

TODO: Write development instructions here

## Contributing

1. Fork it (<https://gitlab.com/arctic-fox/espresso/forks/new>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Merge Request

## Contributors

- [Michael Miller](https://gitlab.com/arctic-fox) - creator and maintainer
20 changes: 20 additions & 0 deletions shard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: espresso
version: 0.1.0

authors:
- Michael Miller <[email protected]>

crystal: 0.28.0

license: MIT

development_dependencies:
spectator:
gitlab: arctic-fox/spectator
ameba:
github: veelenga/ameba
version: ~> 0.9

dependencies:
glfw.cr:
gitlab: arctic-fox/glfw.cr
9 changes: 9 additions & 0 deletions spec/espresso_spec.cr
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
require "./spec_helper"

describe Espresso do
# TODO: Write tests

it "works" do
false.should eq(true)
end
end
2 changes: 2 additions & 0 deletions spec/spec_helper.cr
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require "spec"
require "../src/espresso"
4 changes: 4 additions & 0 deletions src/espresso.cr
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Lightweight wrapper around GLFW for Crystal.
module Espresso
VERSION = "0.1.0"
end

0 comments on commit 5aa4af2

Please sign in to comment.