MediaImporter / README.md
Newer Older
36 lines | 1.657kb
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 3 weeks ago
8
- `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
9
- `samples/code/autonas-media-importer.sh`: The original script that serves as inspiration for this project.
10
- `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.
11

            
12
## Version Control
13

            
14
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.
15

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

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

            
22
## Contribution Guidelines
23

            
24
- All development should focus on `media-importer.sh`.
25
- Do not import or source scripts/functions from the `samples/` directory.
26
- Use resources in `samples/` only for testing and development reference.
27

            
28
## License
29

            
30
Specify your license here.
31

            
32
---
33

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

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