Skip to content

Python tool for converting files and office documents to Markdown.

docs: update README with Devcontainer instructions

lumine0a30295ffde
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index 2ce479b1..f12fbcb3 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -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": {},
diff --git a/README.md b/README.md
index 7079dbfa..1de6cdcb 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/install.sh b/install.sh
deleted file mode 100644
index 7133c159..00000000
--- a/install.sh
+++ /dev/null
@@ -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!"