update Lab2 Readme
This commit is contained in:
@@ -0,0 +1,40 @@
|
|||||||
|
# CSE 5543 Lab 2: Interactive B- Spline Curve Editor
|
||||||
|
|
||||||
|
Author: Zhe Yuan
|
||||||
|
|
||||||
|
## Create Environment
|
||||||
|
|
||||||
|
I use `uv` to create a virtual environment for this project. You can synchronize the environment by running:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv sync
|
||||||
|
```
|
||||||
|
|
||||||
|
`uv` is not the only option, you can run this program in any Python environment with the required dependencies installed. The main dependencies are listed in `pyproject.toml`.
|
||||||
|
|
||||||
|
## Run the Code
|
||||||
|
To run the interactive B-Spline curve editor, execute the following command in your terminal:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run ibspline.py <num_points> <degree> OR <filename>
|
||||||
|
```
|
||||||
|
|
||||||
|
- `<num_points>`: An integer specifying the number of control points to create a new B-Spline curve.
|
||||||
|
- `<degree>`: An integer specifying the degree of the B-Spline curve.
|
||||||
|
- `<filename>`: A string specifying the path to a file containing control points to load an existing B-Spline curve.
|
||||||
|
|
||||||
|
For example, to create a new B-Spline curve with 5 control points and degree 3, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run ibspline.py 5
|
||||||
|
```
|
||||||
|
|
||||||
|
To load control points from a file named `control_points.txt`, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run ibspline.py control_points.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Statement of AI Usage
|
||||||
|
|
||||||
|
I use `Github Copilot`'s Auto Completion feature to help me complete code lines and README faster.
|
||||||
|
|||||||
Reference in New Issue
Block a user