summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.editorconfig9
-rw-r--r--.gitignore5
-rw-r--r--LICENSE21
-rw-r--r--README.md27
-rw-r--r--shard.yml13
-rw-r--r--spec/flint_spec.cr9
-rw-r--r--spec/spec_helper.cr2
-rw-r--r--src/flint.cr6
8 files changed, 92 insertions, 0 deletions
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..b5e5b76
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Matthew Hall <hallmatthew314@gmail.com>
+
+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..16cf336
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# flint
+
+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 (<https://github.com/your-github-user/flint/fork>)
+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
+
+- [Matthew Hall](https://github.com/your-github-user) - creator and maintainer
diff --git a/shard.yml b/shard.yml
new file mode 100644
index 0000000..d22daea
--- /dev/null
+++ b/shard.yml
@@ -0,0 +1,13 @@
+name: flint
+version: 0.1.0
+
+authors:
+ - Matthew Hall <hallmatthew314@gmail.com>
+
+targets:
+ flint:
+ main: src/flint.cr
+
+crystal: 1.5.0
+
+license: MIT
diff --git a/spec/flint_spec.cr b/spec/flint_spec.cr
new file mode 100644
index 0000000..bc30315
--- /dev/null
+++ b/spec/flint_spec.cr
@@ -0,0 +1,9 @@
+require "./spec_helper"
+
+describe Flint do
+ # TODO: Write tests
+
+ it "works" do
+ false.should eq(true)
+ end
+end
diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr
new file mode 100644
index 0000000..075d2f8
--- /dev/null
+++ b/spec/spec_helper.cr
@@ -0,0 +1,2 @@
+require "spec"
+require "../src/flint"
diff --git a/src/flint.cr b/src/flint.cr
new file mode 100644
index 0000000..48d6d30
--- /dev/null
+++ b/src/flint.cr
@@ -0,0 +1,6 @@
+# TODO: Write documentation for `Flint`
+module Flint
+ VERSION = "0.1.0"
+
+ # TODO: Put your code here
+end