beenull/photoprism
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Michael Mayer 2018-10-13 17:28:53 +02:00 committed by GitHub
parent ee5d97df56
commit 0644a5ae52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -24,69 +24,50 @@ That's why we started working on an easy-to-use application that can be hosted a
More screenshots: https://photoprism.org/#screenshots
What to expect
--------------
## What to expect
* Clearly structured Web interface for browsing, organizing and sharing your personal photo collection.
* Import everything without worrying about duplicates or RAW to JPEG conversion.
* Reverse geocoding and automated tagging based on Google TensorFlow.
* No monthly costs. No proprietary formats. No privacy concerns.
For the early birds
-------------------
## For the early birds
This is the official way to test our development snapshot. We just started working on the UI and features are neither complete or stable. Feedback early in development helps saving a lot of time. We're a small team and need to move fast.
You are welcome to get an impression and provide early feedback.
All you need is a Web browser and [Docker](https://store.docker.com/search?type=edition&offering=community)
to run the server. It is available for Mac, Linux and Windows.
Before you start, make sure you got [Docker](https://store.docker.com/search?type=edition&offering=community) installed on your system. It is available for Mac, Linux and Windows.
Note that we just started working on the UI and features are neither complete or stable.
Step-by-step [instructions](https://docs.photoprism.org/en/latest/setup/) can be found
in our User Guide on [docs.photoprism.org](https://docs.photoprism.org/en/latest/).
Developers can skip this and move on to the [Developer Guide](https://github.com/photoprism/photoprism/wiki).
**Step 1:** Download the config file [docker-compose.yml](https://raw.githubusercontent.com/photoprism/photoprism/master/configs/docker-compose.yml) (right click and *Save Link As...*) to a directory of your choice.
## Why this has to be free software
By default, a folder named `Photos` in your home directory will be used to store all images. You don't need to create it.
The development of every commercial product is focused on monetization.
We've built similar apps more than once and every single time the constraints of working
in a profit-oriented corporate environment were an impediment.
We are sure we can do better with only a fraction of the budget. Simplicity can be very powerful.
Go, the programming language in which this software is written in, is a great example. It
was heavily influenced by the ideas of Niklaus Wirth.
PhotoPrism will also create the following sub-directories in your `Photos` folder: `Import`, `Export` and `Originals`. Copy existing photos to `Import`, not directly to `Originals` as they need to be renamed and indexed in order to remove duplicates.
Files that can not be imported - like videos - will stay in the `Import` directory, nothing gets lost.
> Simple, elegant solutions are more effective, but they are harder to find than complex ones, and they require more time, which we too often believe to be unaffordable.
> — NIKLAUS WIRTH, COMMUNICATIONS OF THE ACM, FEB. 1985
If you prefer to use different directory names, you can change them in `docker-compose.yml`. See inline comments for instructions.
**Step 2:** Open a terminal, go to the directory in which you saved the config file and run this command to start the application:
```
docker-compose up -d
```
The Web frontend is now available at http://localhost:2342/. The port can be changed in `docker-compose.yml`. Remember to run `docker-compose restart` every time you touch the config.
**Step 3:** Connect to the application container and run `photoprism import` after putting files in the `Import` folder:
```
docker-compose exec photoprism bash
photoprism import
```
You should now be able to see your photos. You can continue using your favorite tools like Photoshop or Lightroom
to edit images in the `Originals` folder. Run `photoprism index` to reindex them as needed.
Even deleting and adding is possible, if you stick to the naming scheme. Easy, isn't it?
The full documentation can be found on [docs.photoprism.org](https://docs.photoprism.org/en/latest/).
How to contribute
-----------------
## How to contribute
If you have a bug or an idea, read the [contributing guidelines](CONTRIBUTING.md) before opening an issue.
Issues labeled `help wanted` or `good first issue` can be good first contributions.
The best way to get in touch is to write an email to hello@photoprism.org or join our [Telegram](https://t.me/joinchat/B8AmeBAUEugGszzuklsj5w) group. We'd love to hear from you!
Donations
---------
## Donations
Please leave a star if you like this project, it provides enough motivation to keep going.
If you still want to donate, you can do so via [PayPal](https://paypal.me/photoprism/10).
Thank you very much! <3
Sponsorship
-----------
## Sponsorship
We are open to sponsorship proposals to improve our funding while we continue working on our first release and beyond.
Ideally it also enables us to offer perks for contributions and explore new ways of organizing product development.