Skip to content

Commit 1510ca6

Browse files
committed
docs: add caching to workflow and link to dev docs in README
- Add julia-actions/cache to speed up documentation builds - Add dev docs badge and links in README - Clarify stable vs dev documentation for users
1 parent 08db106 commit 1510ca6

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

.github/workflows/Documentation.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ jobs:
2222
- uses: julia-actions/setup-julia@v1
2323
with:
2424
version: '1.10'
25+
- uses: julia-actions/cache@v2
2526
- name: Install dependencies
2627
run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
2728
- name: Build and deploy

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# HPR-LP: A GPU Solver for Linear Programming
22

33
[![Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://polyu-ior.github.io/HPR-LP/)
4+
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://polyu-ior.github.io/HPR-LP/dev/)
45
[![CI](https://github.com/PolyU-IOR/HPR-LP/actions/workflows/CI.yml/badge.svg)](https://github.com/PolyU-IOR/HPR-LP/actions/workflows/CI.yml)
56

67
> **A Julia implementation of the Halpern Peaceman-Rachford (HPR) method for solving linear programming (LP) problems on the GPU.**
78
8-
**📖 [Read the Documentation](https://polyu-ior.github.io/HPR-LP/)**
9+
**📖 Documentation:**
10+
- **[Stable](https://polyu-ior.github.io/HPR-LP/)** - Latest released version (v0.1.3)
11+
- **[Dev](https://polyu-ior.github.io/HPR-LP/dev/)** - Latest from main branch (recommended for development)
912

1013
---
1114

0 commit comments

Comments
 (0)