From: Jerome Jutteau <mojo@couak.net>
Date: Fri, 13 Mar 2015 17:16:11 +0000 (+0100)
Subject: add some readme
X-Git-Tag: 1.1~145
X-Git-Url: https://git.p6c8.net/jirafeau.git/commitdiff_plain/aaf7f366cebffa2963241d09d3f899e041ba51d7?hp=d1ee60f610d6208a6acba1548bd18de774c7de79

add some readme
---

diff --git a/NEWCOMER.txt b/NEWCOMER.txt
new file mode 100644
index 0000000..a4c0fc1
--- /dev/null
+++ b/NEWCOMER.txt
@@ -0,0 +1,30 @@
+Hi,
+
+This document is only made for newcomers in Jirafeau who are digging into
+the code.
+
+Here is a little explaination of Jirafeau's arboresence in a simplified
+view only to show the most importants files and their role.
+
+.
+├── admin.php : adminitration interface, also permits to download files
+├── f.php : permits to download files or show the download page
+├── index.php : only provide a html/javascript client to interact with API
+├── script.php : API interface and it's html documentation
+├── install.php : installation script
+├── tos.php : terms of use the user may edit
+├── lib
+│   ├── config.local.php : user's parameters
+│   ├── config.original.php : default parameters with their documentation
+│   ├── functions.js : javascript functions for html/javascript client
+│   ├── functions.php : core functions and tools of jirafeau
+│   ├── lang : langage folder, contain all langage files
+│   └── template
+│       ├── footer.php
+│       └── header.php
+├── media : folder containing all skins
+└── var-xxxxxxx : folder containing all data
+    ├── async : chunks of uploaded files
+    ├── files : all files that has been successfully uploaded
+    └── links : all links pointing to files with meta-informations
+
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..6d9da0c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,12 @@
+Any project would be sad without it's README file :)
+
+Jirafeau is a web site permitting to upload a file in a simple way and give
+an unique link to it.
+
+Jirafeau is an Open-Source project under AGPL v3 license (see COPYING file)
+
+To install Jirafeau project, just open your browser and go to /install.php
+
+For more informations on Jirafeau project, go to it's web page:
+
+https://gitlab.com/mojo42/Jirafeau/wikis/home