summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2020-05-28 12:49:39 -0400
committerTavian Barnes <tavianator@tavianator.com>2020-06-24 10:01:23 -0400
commit15a4031856ae7b72be3d5491a17adf0a592c40b5 (patch)
tree43708f51351001066d108212870b1bf7bebb0ee4
downloadacap-15a4031856ae7b72be3d5491a17adf0a592c40b5.tar.xz
Initialize a new project
-rw-r--r--.gitignore10
-rw-r--r--Cargo.toml12
-rw-r--r--LICENSE19
-rw-r--r--src/lib.rs3
4 files changed, 44 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..088ba6b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..36f5667
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "acap"
+version = "0.1.0"
+authors = ["Tavian Barnes <tavianator@tavianator.com>"]
+edition = "2018"
+description = "A principled API for nearest neighbor search in both metric and non-metric spaces"
+repository = "https://github.com/tavianator/acap"
+license = "MIT"
+keywords = ["ann", "knn", "nearest-neighbors"]
+categories = ["algorithms", "data-structures"]
+
+[dependencies]
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..02b7b4b
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (C) 2020 Tavian Barnes <tavianator@tavianator.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/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..63d8a0e
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,3 @@
+//! As Close As Possible — [nearest neighbor search] in Rust.
+//!
+//! [nearest neighbor search]: https://en.wikipedia.org/wiki/Nearest_neighbor_search