MediaImporter / README.md
Newer Older
38 lines | 2.013kb
Bogdan Timofte authored 9 months ago
1
# Media Importer Project
2

            
3
This repository contains the development and testing resources for the `media-importer.sh` script, which is the main product of this project.
4

            
5
## Project Structure
6

            
7
- `media-importer.sh`: The primary script under development and testing.
Bogdan Timofte authored 2 weeks ago
8
- `INCIDENTS.md`: Postmortems for data-loss or near-data-loss incidents and the regression rules derived from them.
Bogdan Timofte authored 3 weeks ago
9
- `RPI/`: Raspberry Pi integration prototype. This area is currently frozen because Raspberry Pi 3B+ hardware with 1 GB RAM has not provided reliable validation capacity and may also be affected by hardware defects.
Bogdan Timofte authored 9 months ago
10
- `samples/code/autonas-media-importer.sh`: The original script that serves as inspiration for this project.
11
- `samples/`: Contains code samples, example files, and other resources used for development and testing. **Note:** Scripts and functions are not imported from this directory; it is strictly for reference and testing purposes.
12

            
13
## Version Control
14

            
15
Version control is implemented for all files except the `samples/` directory. The `samples/` directory is excluded from version control to avoid tracking test resources and sample files.
16

            
17
To exclude the `samples/` directory, the following entry should be added to the `.gitignore` file:
18

            
Bogdan Timofte authored 3 weeks ago
19
```gitignore
Bogdan Timofte authored 9 months ago
20
samples/
21
```
22

            
23
## Contribution Guidelines
24

            
25
- All development should focus on `media-importer.sh`.
26
- Do not import or source scripts/functions from the `samples/` directory.
27
- Use resources in `samples/` only for testing and development reference.
Bogdan Timofte authored 2 weeks ago
28
- Destination conflicts must never be delegated to copy/move tools. In unattended runs the importer appends numeric suffixes (`_1`, `_2`, ...); in interactive runs it asks the user and supports applying the choice to all similar conflicts.
Bogdan Timofte authored 9 months ago
29

            
30
## License
31

            
32
Specify your license here.
33

            
34
---
35

            
36
For details on recent changes, including the removal of fallback date handling, see [CHANGELOG.md](./CHANGELOG.md).
37

            
38
This file is intended for GitHub Copilot and contributors to understand the project structure and guidelines.