freecad-preview-extractor 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,11 +15,17 @@ Preview is extracted for each `FILENAME.FCStd` file as `FILENAME-preview.png`
|
|
|
15
15
|
- **Ignore patterns**: Use an ignore config file (like `.gitignore`) to exclude specific files from batch processing
|
|
16
16
|
|
|
17
17
|
## Installation
|
|
18
|
+
|
|
19
|
+
Install globally:
|
|
20
|
+
|
|
18
21
|
```bash
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
npm install -g freecad-preview-extractor
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or run directly with npx:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx freecad-preview-extractor
|
|
23
29
|
```
|
|
24
30
|
|
|
25
31
|
## Usage
|
|
@@ -129,6 +135,17 @@ The project exports utility functions that can be used programmatically:
|
|
|
129
135
|
- `filterIgnoredFiles(filePaths, rootDir, patterns, enabled)` - Filter files based on patterns
|
|
130
136
|
- `shouldIgnoreFile(filePath, rootDir, patterns, enabled)` - Check if a single file should be ignored
|
|
131
137
|
|
|
138
|
+
## Development
|
|
139
|
+
|
|
140
|
+
To set up the project for development:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
git clone https://github.com/andruhon/freecad-preview-extractor.git
|
|
144
|
+
cd ./freecad-preview-extractor
|
|
145
|
+
npm ci
|
|
146
|
+
sudo npm install -g ./
|
|
147
|
+
```
|
|
148
|
+
|
|
132
149
|
## Project Files
|
|
133
150
|
|
|
134
151
|
Key files of the project (not including all files):
|