Added translation using Weblate (Slovenian)

[jirafeau_project.git] / README.md

diff --git a/README.md b/README.md
index 6171e7b3587238bff7c3f6eaf137e73ad911fb7a..45bb71233fbd8a09b6d24b44172b230f3816d116 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,6 +8,11 @@ A demonstration of the latest version is available on [jirafeau.net](http://jira
 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 
 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 

+Latest CI Status:
+Master [![Build Status Master](https://gitlab.com/mojo42/Jirafeau/badges/master/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)
+Next Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/badges/test/build.svg)](https://gitlab.com/mojo42/Jirafeau/commits/master)
+[All Branch Builds](https://gitlab.com/mojo42/Jirafeau/pipelines?scope=branches)
+

 ## Main features
 
 - One upload → One download link & one delete link
 ## Main features
 
 - One upload → One download link & one delete link


@@ -28,7 +33,7 @@ A demonstration of the latest version is available on [jirafeau.net](http://jira
 - Basic, adaptable »Terms Of Service« page
 - Basic API
 - Bash script to upload files via command line
 - Basic, adaptable »Terms Of Service« page
 - Basic API
 - Bash script to upload files via command line

-- Skins
+- Themes

 
 Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.
 
 
 Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.
 


@@ -50,15 +55,20 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe
 
 ## Installation
 
 
 ## Installation
 

--  [Download](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip) the last version of Jirafeau from GitLab
--  Upload files on your web server
--  Don't forget to set owner of uploaded files if you need to
--  Get your web browser and go to you install location (e.g. ```http://your-web-site.org/jirafeau/```) and follow instructions
--  Some options are not configured from the minimal installation wizard, you may take a look at option documentation in ```lib/config.original.php``` and customize your ```lib/config.local.php```
-
-Note that ```lib/config.local.php``` is auto-generated during the installation.
-
-If you don't want to go through the installation wizard, you can just copy ```config.original.php``` to ```config.local.php``` and customize it.
+System requirements:
+- PHP >= 5.6
+- Optional, but recommended: Git >= 2.7
+- No database required, no mail required
+
+Installation steps:
+- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest ([release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver
+- Set owner & group according to your webserver
+- A) Setup with the installation wizard (web):
+  - Open your browser and go to your installed location, eg. ```https://example.com/jirafeau/```
+  - The script will redirect to you to a minimal installation wizard to set up all required options
+  - All optional parameters may be set in ```lib/config.local.php```, take a look at ```lib/config.original.php``` to see all default values
+- B) Setup without the installation wizard (cli):
+  - Just copy ```config.original.php``` to ```config.local.php``` and customize it

 
 ## Upgrade
 
 
 ## Upgrade
 


@@ -76,14 +86,22 @@ If you don't want to go through the installation wizard, you can just copy ```co
 
 1. The download URL changed
    * Add a rewrite rule in your web server configuration to rename ```file.php``` to ```f.php``` to make older, still existing links work again
 
 1. The download URL changed
    * Add a rewrite rule in your web server configuration to rename ```file.php``` to ```f.php``` to make older, still existing links work again

-1. The default skin changed
-   * Optionally change the skin in ```lib/config.local.php``` to »courgette«
+1. The default theme changed
+   * Optionally change the theme in ```lib/config.local.php``` to »courgette«

 
 ### From version 1.2.0 to 2.0.0
 
 1. The "Terms of Service" text file changed
    * To reuse previous changes to the ToS, move the old ```/tos_text.php``` file to ```/lib/tos.local.txt``` and remove all HTML und PHP Tags, leaving a regular text file
 
 
 ### From version 1.2.0 to 2.0.0
 
 1. The "Terms of Service" text file changed
    * To reuse previous changes to the ToS, move the old ```/tos_text.php``` file to ```/lib/tos.local.txt``` and remove all HTML und PHP Tags, leaving a regular text file
 

+### From version 2.0.0 to 3.0.0
+
+1. No special change to upgrade to 3.0.0
+
+### From version 2.0.0 to 3.1.0
+
+1. No special change to upgrade to 3.1.0
+

 ### Troubleshooting
 
 If you have some troubles, consider the following cases
 ### Troubleshooting
 
 If you have some troubles, consider the following cases


@@ -133,12 +151,12 @@ In a next step, encryption will be made by the client (in javascript), see issue
 
 ## License
 
 
 ## License
 

-GNU Affero General Public License version 3 (AGPLv3).
+GNU Affero General Public License v3 (AGPL-3.0).

 
 The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.
 
 Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated, 
 
 The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.
 
 Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated, 

-you are required to provide a link to the source code of your version in order to obey the AGPLv3 license. 
+you are required to provide a link to the source code of your version in order to obey the AGPL-3.0 license.

 To do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page.
 Take a look at the FAQ to find out about how to change the ToS.
 
 To do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page.
 Take a look at the FAQ to find out about how to change the ToS.
 


@@ -195,6 +213,14 @@ If you have some strange behavior with IE, you may configure [compatibility mode
 
 Anyway I would recommend you to use another web browser. :)
 
 
 Anyway I would recommend you to use another web browser. :)
 

+### How can I change the theme?
+
+You may change the default theme to any of the existing ones or a custom.
+
+Open your ```lib/config.local.php``` and change setting in the »`style`« key to the name of any folder in the ```/media``` directory.
+
+Hint: To create a custom theme just copy the »courgette« folder and name your theme »custom« (this way it will be ignored by git and not overwritten during updates). You are invited to enhance the existing themes and send pull requests however.
+

 ### I found a bug, what should I do?
 
 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).
 ### I found a bug, what should I do?
 
 Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).


@@ -334,3 +360,22 @@ The very first version of Jirafeau after the fork of Jyraphe.
 - Set a custom title
 - Bash Script: Enhanced help, show version, return link to web view as well
 - »Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes
 - Set a custom title
 - Bash Script: Enhanced help, show version, return link to web view as well
 - »Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes

+
+## Version 3.0.0
+
+- Remove XHTML doctype, support HTML5 only → breaking change for older browsers
+- Remove redundant code
+- Remove baseurl usage and set absolute links instead, which for example fixes SSL issues
+- Extend contribution guide
+- Switch to PSR-2 code style (fix line endings, indentations, whitespaces, etc)
+- Declare system requirements
+- Catch API errors in upload form
+- Allow clients to upload files depending on IP or password
+- Set UTC as timezone to prevent date/time issues
+- Show readable date & time information
+- Fix UI glitches in admin panel and upload form
+
+## Version 3.1.0
+
+- Fix regression on user authentication (see #113)
+- Some cosmetic change