Skip to content

Commit 57b8feb

Browse files
authored
Initial commit
0 parents  commit 57b8feb

9 files changed

Lines changed: 119 additions & 0 deletions

File tree

.github/workflows/CI.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
test:
15+
runs-on: ubuntu-latest
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
julia-version: ["1.10", "1.11"]
20+
steps:
21+
- uses: actions/checkout@v4
22+
- uses: julia-actions/setup-julia@v2
23+
with:
24+
version: ${{ matrix.julia-version }}
25+
- uses: julia-actions/cache@v2
26+
- uses: julia-actions/julia-buildpkg@v1
27+
- uses: julia-actions/julia-runtest@v1

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Manifest.toml
2+
.vscode/
3+
*.jl.cov
4+
*.jl.mem

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [Unreleased]

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Joshua C. Macdonald
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Project.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name = "PACKAGE_NAME"
2+
uuid = "00000000-0000-0000-0000-000000000000"
3+
authors = ["Joshua C. Macdonald <jmacdo16@jh.edu>"]
4+
version = "0.1.0"
5+
6+
[deps]
7+
8+
[compat]
9+
julia = "1.10"
10+
11+
[extras]
12+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
13+
14+
[targets]
15+
test = ["Test"]

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# PACKAGE_NAME
2+
3+
DESCRIPTION
4+
5+
## Installation
6+
7+
```julia
8+
using Pkg
9+
Pkg.add("PACKAGE_NAME")
10+
```
11+
12+
## Development
13+
14+
```bash
15+
julia --project=. -e 'using Pkg; Pkg.instantiate()'
16+
just test
17+
```
18+
19+
## License
20+
21+
MIT

justfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
set shell := ["bash", "-uc"]
2+
3+
default: test
4+
5+
# Run tests.
6+
test:
7+
julia --project=. -e 'using Pkg; Pkg.test()'
8+
9+
# Format source files (requires JuliaFormatter).
10+
format:
11+
julia --project=. -e 'using JuliaFormatter; format("src"); format("test")'
12+
13+
# Instantiate project dependencies.
14+
setup:
15+
julia --project=. -e 'using Pkg; Pkg.instantiate()'

src/PACKAGE_NAME.jl

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module PACKAGE_NAME
2+
3+
# TODO: exports
4+
5+
end # module

test/runtests.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
using PACKAGE_NAME
2+
using Test
3+
4+
@testset "PACKAGE_NAME.jl" begin
5+
@test true # smoke test
6+
end

0 commit comments

Comments
 (0)