commit 0533f0f1cf1fe9a7fcaa67002743567586aac112 Author: Anton Vakhrushev Date: Fri Aug 9 16:33:26 2019 +0300 Init scaffolding diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..163eb75 --- /dev/null +++ b/.editorconfig @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0bb75ea --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/docs/ +/lib/ +/bin/ +/.shards/ +*.dwarf diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0bfc21c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 your-name-here + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4ece00 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# village + +TODO: Write a description here + +## Installation + +TODO: Write installation instructions here + +## Usage + +TODO: Write usage instructions here + +## Development + +TODO: Write development instructions here + +## Contributing + +1. Fork it () +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 Pull Request + +## Contributors + +- [your-name-here](https://github.com/your-github-user) - creator and maintainer diff --git a/cr b/cr new file mode 100755 index 0000000..cf5ed3d --- /dev/null +++ b/cr @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -eu + +docker run -it \ + -u "$(id -u):$(id -g)" \ + -v "$PWD:/app" \ + -w "/app" \ + crystallang/crystal:0.30.0 crystal "$@" \ No newline at end of file diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..27cb0f4 --- /dev/null +++ b/shard.yml @@ -0,0 +1,13 @@ +name: village +version: 0.1.0 + +authors: + - your-name-here + +targets: + village: + main: src/village.cr + +crystal: 0.30.0 + +license: MIT diff --git a/shards b/shards new file mode 100755 index 0000000..86d865a --- /dev/null +++ b/shards @@ -0,0 +1,9 @@ +#!/usr/bin/env bash + +set -eu + +docker run -it \ + -u "$(id -u):$(id -g)" \ + -v "$PWD:/app" \ + -w "/app" \ + crystallang/crystal:0.30.0 shards "$@" diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..0af9d20 --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/village" diff --git a/spec/village_spec.cr b/spec/village_spec.cr new file mode 100644 index 0000000..60e66a6 --- /dev/null +++ b/spec/village_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Village do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/src/village.cr b/src/village.cr new file mode 100644 index 0000000..50191c8 --- /dev/null +++ b/src/village.cr @@ -0,0 +1,6 @@ +# TODO: Write documentation for `Village` +module Village + VERSION = "0.1.0" + + # TODO: Put your code here +end