Skip to content

Commit

Permalink
Add missing readme parts
Browse files Browse the repository at this point in the history
  • Loading branch information
askolesov committed Oct 24, 2024
1 parent 561ce90 commit 2723bc4
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,51 @@ sidecarExtensions:
```
You can modify this configuration to suit your photo organization needs. The `template` field is particularly important as it determines how your photos will be organized in the library based on their metadata.

## Building from Source

To build Image Vault from source:

1. Clone the repository:
```
git clone https://github.com/askolesov/image-vault.git
```

2. Navigate to the project directory:
```
cd image-vault
```

3. Build the project:
```
make build
```

This will create the `imv` binary in the `build/` directory.

4. (Optional) Install the binary:
```
make install
```

## Contributing

Contributions to Image Vault are welcome! Please feel free to submit pull requests, create issues, or suggest improvements.

Before submitting a pull request, please ensure that:

1. Your code passes all tests:
```
make test
```

2. Your code passes the linter:
```
make lint
```

3. You've added tests for any new functionality.

## License

// TODO: add license

0 comments on commit 2723bc4

Please sign in to comment.