docs: update README with Devcontainer instructions

Add instructions for using Dev to run tests.Remove the install script it is no longer needed. 
Update trademark section for clarity.
This commit is contained in:
lumin
2024-12-17 11:36:15 +09:00
committed by GitButler
parent 07fe457a90
commit e0a30295ff
3 changed files with 9 additions and 10 deletions

View File

@@ -20,7 +20,6 @@
// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "cat /etc/os-release",
"postCreateCommand": "./install.sh",
// Configure tool-specific properties.
// "customizations": {},

View File

@@ -103,6 +103,13 @@ hatch shell
hatch test
```
Alternative method: using Devcontainer
- Reopen project in the Devcontainer (via the Command Palette: `Reopen in Container`)
- Once inside the container, run:
```sh
hatch test
```
### Running Pre-commit Checks
Please run the pre-commit checks before submitting a PR.
@@ -113,8 +120,8 @@ pre-commit run --all-files
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.

View File

@@ -1,7 +0,0 @@
#!/bin/sh
# Install the current project in editable mode
echo "Installing the project in editable mode..."
pip install -e .
echo "Setup complete!"