Updated README
This commit is contained in:
parent
f34176c2eb
commit
6065a20408
37
README.md
37
README.md
|
@ -1,4 +1,5 @@
|
||||||
# PhotoPrism - Open-Source Photo Management
|
PhotoPrism: Long-Term Digital Photo Archiving
|
||||||
|
=============================================
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/photoprism/photoprism.png?branch=master)][ci]
|
[![Build Status](https://travis-ci.org/photoprism/photoprism.png?branch=master)][ci]
|
||||||
[![Code Quality](https://goreportcard.com/badge/github.com/photoprism/photoprism)][code quality]
|
[![Code Quality](https://goreportcard.com/badge/github.com/photoprism/photoprism)][code quality]
|
||||||
|
@ -10,16 +11,38 @@
|
||||||
[issues]: https://github.com/photoprism/photoprism/issues
|
[issues]: https://github.com/photoprism/photoprism/issues
|
||||||
[license]: https://github.com/photoprism/photoprism/blob/master/LICENSE
|
[license]: https://github.com/photoprism/photoprism/blob/master/LICENSE
|
||||||
|
|
||||||
**PhotoPrism is still under development. Your welcome to join our team.**
|
PhotoPrism is a free tool for managing large amounts of
|
||||||
|
JPEG and RAW photos. All data is intentionally stored in the file system for easy
|
||||||
|
backup and reliable long-term accessibility.
|
||||||
|
|
||||||
Our goal is to provide a free software for managing large amounts of
|
**Note: This software is still pre-alpha and under active development.
|
||||||
JPEG and RAW photos on your own server. Images are stored in the file
|
You're welcome to join our team.**
|
||||||
systems for easy backups and reliable long-term accessibility.
|
|
||||||
|
Our goal is to provide the following features (tested as a proof-of-concept):
|
||||||
|
|
||||||
- High-performance command line tool
|
- High-performance command line tool
|
||||||
- Optional Web frontend
|
- Web frontend
|
||||||
- No proprietary or binary data formats
|
- No proprietary or binary data formats
|
||||||
- Duplicate detection
|
- Duplicate detection
|
||||||
- Automated tagging using Google TensorFlow
|
- Automated tagging using Google TensorFlow
|
||||||
- Image search with powerful filters
|
- Image search with powerful filters
|
||||||
- Easy backup and export
|
- Easy backup and export
|
||||||
|
|
||||||
|
Unit Tests
|
||||||
|
----------
|
||||||
|
|
||||||
|
Tests are currently not running on Travis CI as they require
|
||||||
|
docker container configuration that is still on the todo list. We
|
||||||
|
will provide a testing guide once everything is up and running.
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
------------
|
||||||
|
We are using [dep](https://github.com/golang/dep) for dependency management:
|
||||||
|
|
||||||
|
```
|
||||||
|
dep ensure
|
||||||
|
go test
|
||||||
|
```
|
||||||
|
|
||||||
|
In addition, PhotoPrism requires [darktable](https://www.darktable.org/) to convert RAW images to JPEG.
|
||||||
|
We are working on a docker container that contains it so that you don't have to install it locally.
|
Loading…
Reference in a new issue