Updated documentation
This commit is contained in:
parent
7a6c9464cd
commit
48ac7ff054
29
Gopkg.lock
generated
29
Gopkg.lock
generated
|
@ -43,6 +43,12 @@
|
||||||
packages = ["yaml"]
|
packages = ["yaml"]
|
||||||
revision = "08cad365cd28a7fba23bb1e57aa43c5e18ad8bb8"
|
revision = "08cad365cd28a7fba23bb1e57aa43c5e18ad8bb8"
|
||||||
|
|
||||||
|
[[projects]]
|
||||||
|
branch = "master"
|
||||||
|
name = "github.com/photoprism/photoprism"
|
||||||
|
packages = ["."]
|
||||||
|
revision = "7a6c9464cdef3048cd7558fd11e19bbc290312a3"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
name = "github.com/pkg/errors"
|
name = "github.com/pkg/errors"
|
||||||
packages = ["."]
|
packages = ["."]
|
||||||
|
@ -58,7 +64,11 @@
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "go1"
|
branch = "go1"
|
||||||
name = "github.com/rwcarlsen/goexif"
|
name = "github.com/rwcarlsen/goexif"
|
||||||
packages = ["exif","mknote","tiff"]
|
packages = [
|
||||||
|
"exif",
|
||||||
|
"mknote",
|
||||||
|
"tiff"
|
||||||
|
]
|
||||||
revision = "17202558c8d9c3fd047859f1a5e73fd9ae709187"
|
revision = "17202558c8d9c3fd047859f1a5e73fd9ae709187"
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
|
@ -75,7 +85,10 @@
|
||||||
|
|
||||||
[[projects]]
|
[[projects]]
|
||||||
name = "github.com/tensorflow/tensorflow"
|
name = "github.com/tensorflow/tensorflow"
|
||||||
packages = ["tensorflow/go","tensorflow/go/op"]
|
packages = [
|
||||||
|
"tensorflow/go",
|
||||||
|
"tensorflow/go/op"
|
||||||
|
]
|
||||||
revision = "37aa430d84ced579342a4044c89c236664be7f68"
|
revision = "37aa430d84ced579342a4044c89c236664be7f68"
|
||||||
version = "v1.5.0"
|
version = "v1.5.0"
|
||||||
|
|
||||||
|
@ -88,12 +101,20 @@
|
||||||
[[projects]]
|
[[projects]]
|
||||||
branch = "master"
|
branch = "master"
|
||||||
name = "golang.org/x/image"
|
name = "golang.org/x/image"
|
||||||
packages = ["bmp","riff","tiff","tiff/lzw","vp8","vp8l","webp"]
|
packages = [
|
||||||
|
"bmp",
|
||||||
|
"riff",
|
||||||
|
"tiff",
|
||||||
|
"tiff/lzw",
|
||||||
|
"vp8",
|
||||||
|
"vp8l",
|
||||||
|
"webp"
|
||||||
|
]
|
||||||
revision = "12117c17ca67ffa1ce22e9409f3b0b0a93ac08c7"
|
revision = "12117c17ca67ffa1ce22e9409f3b0b0a93ac08c7"
|
||||||
|
|
||||||
[solve-meta]
|
[solve-meta]
|
||||||
analyzer-name = "dep"
|
analyzer-name = "dep"
|
||||||
analyzer-version = 1
|
analyzer-version = 1
|
||||||
inputs-digest = "ea6460db0c53d350b75d5795872ab17c55d0348840b77a27618da6bd75d329ad"
|
inputs-digest = "b3174d1366468b5b9de596cebcbf97d941b95ce61cca9c13ca5456379f2f68c2"
|
||||||
solver-name = "gps-cdcl"
|
solver-name = "gps-cdcl"
|
||||||
solver-version = 1
|
solver-version = 1
|
||||||
|
|
62
README.md
62
README.md
|
@ -1,5 +1,5 @@
|
||||||
PhotoPrism: Long-Term Digital Photo Archiving
|
PhotoPrism: Digital Photo Archive
|
||||||
=============================================
|
=================================
|
||||||
|
|
||||||
[![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]
|
||||||
|
@ -15,7 +15,41 @@ PhotoPrism is a free tool for importing, filtering and archiving large amounts o
|
||||||
JPEG and RAW files. Originals, thumbnails and metadata are stored in the file system for easy
|
JPEG and RAW files. Originals, thumbnails and metadata are stored in the file system for easy
|
||||||
backup and reliable long-term accessibility.
|
backup and reliable long-term accessibility.
|
||||||
|
|
||||||
**Note: This software is still pre-alpha and under active development.
|
Setup
|
||||||
|
-----
|
||||||
|
Before you start, make sure you got Git and Docker installed on your system.
|
||||||
|
Instead of using Docker, you can also setup your own runtime environment
|
||||||
|
based on the existing Docker configuration.
|
||||||
|
|
||||||
|
**Step 1:** Run [Git](https://getcomposer.org/) to clone this project:
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone git@github.com:photoprism/photoprism.git
|
||||||
|
```
|
||||||
|
|
||||||
|
**Step 2:** Start [Docker](https://www.docker.com/) containers:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd photoprism
|
||||||
|
docker-compose up
|
||||||
|
```
|
||||||
|
|
||||||
|
*Note: This docker-compose configuration is for testing and development purposes only.*
|
||||||
|
|
||||||
|
**Step 3:** Open a terminal to run commands and unit tests:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker-compose exec photoprism sh
|
||||||
|
dep ensure
|
||||||
|
go test
|
||||||
|
go build cmd/photoprism/photoprism.go
|
||||||
|
./photoprism
|
||||||
|
```
|
||||||
|
|
||||||
|
About
|
||||||
|
-----
|
||||||
|
|
||||||
|
**Note: This software is still alpha and under active development.
|
||||||
You're welcome to join our team.**
|
You're welcome to join our team.**
|
||||||
|
|
||||||
Our goal is to provide the following features (tested as a proof-of-concept):
|
Our goal is to provide the following features (tested as a proof-of-concept):
|
||||||
|
@ -28,24 +62,4 @@ Our goal is to provide the following features (tested as a proof-of-concept):
|
||||||
- Image search with powerful filters
|
- Image search with powerful filters
|
||||||
- Easy backup and export
|
- Easy backup and export
|
||||||
|
|
||||||
![](https://www.dropbox.com/s/m1cnl8mn4s4ub8h/concept.jpg?dl=1)
|
![](assets/img/concept.jpg)
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
BIN
assets/img/concept.jpg
Normal file
BIN
assets/img/concept.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 110 KiB |
|
@ -12,8 +12,8 @@ func main() {
|
||||||
|
|
||||||
app := cli.NewApp()
|
app := cli.NewApp()
|
||||||
app.Name = "PhotoPrism"
|
app.Name = "PhotoPrism"
|
||||||
app.Usage = "Long-Term Digital Photo Archiving"
|
app.Usage = "Digital Photo Archive"
|
||||||
app.Version = "0.0.2"
|
app.Version = "0.0.3"
|
||||||
app.Flags = globalCliFlags
|
app.Flags = globalCliFlags
|
||||||
app.Commands = []cli.Command{
|
app.Commands = []cli.Command{
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue