Update readme

[kacienk]

README update. Closes #12.

[Copilot]

Pull Request Overview

This PR modernizes and expands the README by adding a live demo link, clarifying setup steps, and updating contributors.

• Introduces a "Live Demo" section with deployment URL
• Reorganizes prerequisites, installation, running, and deployment steps with emojis
• Updates contributor links and adds course attribution

Comments suppressed due to low confidence (3)

README.md:31

• Replace the placeholder "your-username" with the actual repository owner (e.g., jkbstepien) to ensure the clone URL works correctly.

git clone https://github.com/your-username/rustoscope.git

README.md:8

• The project description section was removed; consider re-adding or relocating a concise description of the project to help new readers understand its purpose.

## Description

README.md:12

• [nitpick] Use descriptive link text instead of the raw URL to improve readability and accessibility (e.g., Live Demo).

🔗 [https://jkbstepien.github.io/rustoscope/](https://jkbstepien.github.io/rustoscope/)

[grzanka]

grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
Error: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

Caused by: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

grzanka@grzankax1:~/workspace/rustoscope/api$ rustc --version
rustc 1.75.0 (82e1608df 2023-12-21) (built from a source tarball)
grzanka@grzankax1:~/workspace/rustoscope/api$ cargo --version
cargo 1.75.0
grzanka@grzankax1:~/workspace/rustoscope/api$ rm Cargo.lock 
grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
[INFO]: 🎯  Checking for the Wasm target...
Error: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Caused by: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

[kacienk]

grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
Error: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

Caused by: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

grzanka@grzankax1:~/workspace/rustoscope/api$ rustc --version
rustc 1.75.0 (82e1608df 2023-12-21) (built from a source tarball)
grzanka@grzankax1:~/workspace/rustoscope/api$ cargo --version
cargo 1.75.0
grzanka@grzankax1:~/workspace/rustoscope/api$ rm Cargo.lock 
grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
[INFO]: 🎯  Checking for the Wasm target...
Error: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Caused by: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Could you look into that @jkbstepien?

[jkbstepien]

grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
Error: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

Caused by: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

grzanka@grzankax1:~/workspace/rustoscope/api$ rustc --version
rustc 1.75.0 (82e1608df 2023-12-21) (built from a source tarball)
grzanka@grzankax1:~/workspace/rustoscope/api$ cargo --version
cargo 1.75.0
grzanka@grzankax1:~/workspace/rustoscope/api$ rm Cargo.lock 
grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
[INFO]: 🎯  Checking for the Wasm target...
Error: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Caused by: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Could you look into that @jkbstepien?

1. "lock file version 4 requires -Znext-lockfile-bump" it is not a problem with older cargo version installed? When creating project I chose default (latest) available for me:
   ➜ ~ rustc --version
   rustc 1.86.0 (05f9846f8 2025-03-31)
   ➜ ~ cargo --version
   cargo 1.86.0 (adf9b6ad1 2025-02-28)
2. "Caused by: wasm32-unknown-unknown target not found in sysroot: '/usr'" maybe try running rustup target add wasm32-unknown-unknown? This configuration tells the Rust compiler to generate WebAssembly binaries for specified target (in this case usable by web browsers).

[grzanka]

grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
Error: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

Caused by: `cargo metadata` exited with an error: error: failed to parse lock file at: /home/grzanka/workspace/rustoscope/api/Cargo.lock

Caused by:
  lock file version 4 requires `-Znext-lockfile-bump`

grzanka@grzankax1:~/workspace/rustoscope/api$ rustc --version
rustc 1.75.0 (82e1608df 2023-12-21) (built from a source tarball)
grzanka@grzankax1:~/workspace/rustoscope/api$ cargo --version
cargo 1.75.0
grzanka@grzankax1:~/workspace/rustoscope/api$ rm Cargo.lock 
grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
[INFO]: 🎯  Checking for the Wasm target...
Error: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Caused by: wasm32-unknown-unknown target not found in sysroot: "/usr"

Used rustc from the following path: "/usr/bin/rustc"
It looks like Rustup is not being used. For non-Rustup setups, the wasm32-unknown-unknown target needs to be installed manually. See https://rustwasm.github.io/wasm-pack/book/prerequisites/non-rustup-setups.html on how to do this.

Could you look into that @jkbstepien?

1. "lock file version 4 requires `-Znext-lockfile-bump`" it is not a problem with older cargo version installed? When creating project I chose default (latest) available for me:
   ➜  ~ rustc --version
   rustc 1.86.0 (05f9846f8 2025-03-31)
   ➜  ~ cargo --version
   cargo 1.86.0 (adf9b6ad1 2025-02-28)

2. "Caused by: wasm32-unknown-unknown target not found in sysroot: '/usr'" maybe try running `rustup target add wasm32-unknown-unknown`? This configuration tells the Rust compiler to generate WebAssembly binaries for specified target (in this case usable by web browsers).

I had rust installed system-wide previously using apt (same as I did for python and gcc) : I prefer this method as it gives convenient uninstallation method. If you have some requirements for minimal rust/cargo version thats OK, but please specify that in README.md. Same for installation method: if the commands you provide doesn't work with system-wide installation its OK as well, just write that plain-clean for users

[grzanka]

With rustup installation everything went well:

grzanka@grzankax1:~/workspace/rustoscope/api$ wasm-pack build --target web --out-dir ../client/src/wasm
[INFO]: 🎯  Checking for the Wasm target...
info: downloading component 'rust-std' for 'wasm32-unknown-unknown'
info: installing component 'rust-std' for 'wasm32-unknown-unknown'
 19.6 MiB /  19.6 MiB (100 %)  18.9 MiB/s in  1s         
[INFO]: 🌀  Compiling to Wasm...
   Compiling proc-macro2 v1.0.95
   Compiling unicode-ident v1.0.18
   Compiling wasm-bindgen-shared v0.2.100
   Compiling simd-adler32 v0.3.7
   Compiling cfg-if v1.0.0
   Compiling adler2 v2.0.0
   Compiling log v0.4.27
   Compiling autocfg v1.4.0
   Compiling bumpalo v3.18.1
   Compiling rustversion v1.0.21
   Compiling weezl v0.1.10
   Compiling jpeg-decoder v0.3.1
   Compiling crc32fast v1.4.2
   Compiling miniz_oxide v0.8.8
   Compiling fdeflate v0.3.7
   Compiling wasm-bindgen v0.2.100
   Compiling bitflags v1.3.2
   Compiling bytemuck v1.23.0
   Compiling once_cell v1.21.3
   Compiling color_quant v1.1.0
   Compiling byteorder v1.5.0
   Compiling num-traits v0.2.19
   Compiling flate2 v1.1.2
   Compiling quote v1.0.40
   Compiling syn v2.0.101
   Compiling tiff v0.9.1
   Compiling png v0.17.16
   Compiling image v0.24.9
   Compiling wasm-bindgen-backend v0.2.100
   Compiling wasm-bindgen-macro-support v0.2.100
   Compiling wasm-bindgen-macro v0.2.100
   Compiling wasm-api v0.1.0 (/home/grzanka/workspace/rustoscope/api)
    Finished `release` profile [optimized] target(s) in 5.61s
[INFO]: ⬇️  Installing wasm-bindgen...
[INFO]: Optimizing wasm binaries with `wasm-opt`...
[INFO]: Optional fields missing from Cargo.toml: 'description', 'repository', and 'license'. These are not necessary, but recommended
[INFO]: ✨   Done in 24.24s
[INFO]: 📦   Your wasm pkg is ready to publish at /home/grzanka/workspace/rustoscope/client/src/wasm.

[grzanka]

see inline comments