Add rustup depdendency, add just & Justfile, add Getting Started to R…

…EADME
TBD54566975 · Apr 29, 2024 · fd6db84 · fd6db84
1 parent 0124fd5
commit fd6db84
Show file tree

Hide file tree

Showing 20 changed files with 59 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,4 +11,8 @@ Cargo.lock
 **/*.rs.bk
 
 # MSVC Windows builds of rustc generate these, which store debugging information
-*.pdb
+*.pdb
+
+# ---
+
+.hermit/
diff --git a/Justfile b/Justfile
@@ -0,0 +1,20 @@
+set shell := ["bash", "-uc"]
+
+default: setup
+
+# Setup local development environment
+setup:
+  rustup default stable
+
+# Build a release variant
+build:
+  cargo build --release
+
+# Run all tests
+test:
+  cargo test
+
+# Run linting, look for warnings in the output to correct
+lint:
+  cargo clippy --workspace
+  cargo fmt
diff --git a/README.md b/README.md
@@ -1,3 +1,18 @@
-# Work in progress
+# Work in progress <!-- omit in toc -->
 
-This repo is not ready for consumption, and is under heavy development
+This repo is not ready for consumption, and is under heavy development
+
+- [Getting Started](#getting-started)
+  - [Setup](#setup)
+
+## Getting Started
+
+### Setup
+
+```shell
+just setup # this will configure your rust environment
+```
+
+```shell
+just --list
+```
diff --git a/bin/.just-1.25.2.pkg b/bin/.just-1.25.2.pkg
@@ -0,0 +1 @@
+hermit
diff --git a/bin/.rustup-1.25.2.pkg b/bin/.rustup-1.25.2.pkg
@@ -0,0 +1 @@
+hermit
diff --git a/bin/cargo b/bin/cargo
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/cargo-clippy b/bin/cargo-clippy
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/cargo-fmt b/bin/cargo-fmt
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/cargo-miri b/bin/cargo-miri
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/clippy-driver b/bin/clippy-driver
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/just b/bin/just
@@ -0,0 +1 @@
+.just-1.25.2.pkg
diff --git a/bin/rls b/bin/rls
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rust-analyzer b/bin/rust-analyzer
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rust-gdb b/bin/rust-gdb
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rust-gdbgui b/bin/rust-gdbgui
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rust-lldb b/bin/rust-lldb
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rustc b/bin/rustc
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rustdoc b/bin/rustdoc
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rustfmt b/bin/rustfmt
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg
diff --git a/bin/rustup b/bin/rustup
@@ -0,0 +1 @@
+.rustup-1.25.2.pkg