From f2a885a64fb7fc697dc3a6b1c11c3a018fdb12b3 Mon Sep 17 00:00:00 2001 From: Aron T Date: Fri, 17 Jul 2026 17:48:47 +0300 Subject: [PATCH] Fix stale DrWatson-era README.md Replace DrWatson @quickactivate instructions (removed during the workspace restructure) with the actual Julia workspace setup, and complete the docs link to https://study.fourm.info/linear_algebra/dev/. Derived from the new canonical project_resources/github/README.md template. Closes FOU-112 --- README.md | 68 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 42 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 72b2621..d01b79f 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,57 @@ # Linear_Algebra -This code base is using the [Julia Language](https://julialang.org/) and -[DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/) -to make a reproducible scientific project named -> Linear_Algebra +A Julia study project covering linear algebra topics (vectors, matrices, systems of equations, +analytic geometry, transformations), adapted from several linear algebra and geometry textbooks. -It is authored by Aron T. +This repository uses a [Julia](https://julialang.org/) workspace for reproducibility — see +[Julia Workspace Layout](.github/copilot-instructions.md) in the Copilot instructions for the +full member/environment breakdown. -To (locally) reproduce this project, do the following: +## Setup -1. Download this code base. Notice that raw data are typically not included in the - git-history and may need to be downloaded independently. -2. Open a Julia console and do: +1. Clone this repository. +2. Instantiate the root environment (library + its production dependencies): ```julia - julia> using Pkg - julia> Pkg.add("DrWatson") # install globally, for using `quickactivate` - julia> Pkg.activate("path/to/this/project") - julia> Pkg.instantiate() + julia --project=. -e 'using Pkg; Pkg.instantiate()' ``` -This will install all necessary packages for you to be able to run the scripts and -everything should work out of the box, including correctly finding local paths. +3. Run the tests (uses the `test/` workspace member environment): -You may notice that most scripts start with the commands: + ```julia + julia --project=. -e 'using Pkg; Pkg.test()' + ``` + +4. Build the documentation locally (uses the `docs/` workspace member environment): + + ```julia + julia --project=docs docs/make.jl + ``` + + The built site is in `docs/build/` — open `docs/build/index.html` in a browser. -```julia -using DrWatson -@quickactivate "Linear_Algebra" +### Notebook Setup + +`notebooks/` is **not** a workspace member, so `Linear_Algebra` is not auto-resolved there. +After cloning (or after removing `notebooks/Manifest.toml`), run once in the notebooks directory: + +```julia-repl +julia --project=./notebooks +``` + +Then in the REPL Pkg mode (press `]`): + +```julia-repl +pkg> dev .. +pkg> instantiate ``` -which auto-activate the project and enable local path handling from DrWatson. +This creates `notebooks/Manifest.toml` (gitignored) with `path = ".."` pointing at the root +package. Subsequent `julia --project=./notebooks` invocations will resolve +`Linear_Algebra` from the local source. + +## Documentation -Some documentation has been set up for this project. It can be viewed by -running the file `docs/make.jl`, and then launching the generated file -`docs/build/index.html`. -Alternatively, the documentation may be already hosted online. -If this is the case it should be at: +Documentation is deployed cross-repo to the Math & Tech Study Hub: -[https://study.fourm.info/linear_algebra/](https://study.fourm.info/linear_algebra/) +