Merge branch 'init' of github.com:httpdss/struct into init

Author: httpdss

.github/workflows/pre-commit.yaml

@@ -0,0 +1,15 @@
+name: pre-commit
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml

README.md

@@ -64,6 +64,25 @@ structure:
       file: https://raw.githubusercontent.com/nishanths/license/master/LICENSE
 ```
 
+## Development
+
+To get started with development, follow these steps:
+
+1. Clone the repository
+2. Create a virtual environment
+
+```sh
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+3. Install the dependencies
+
+```sh
+pip install -r requirements.txt
+pip install -r requirements.dev.txt
+```
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.