Browse Source

New README file referencing to a lot of information

tags/stw2018
Max Mehl 1 year ago
parent
commit
83d071a74a
Signed by: mxmehl <mail@mehl.mx> GPG Key ID: 2704E4AB371E2E92
1 changed files with 64 additions and 0 deletions
  1. 64
    0
      README.md

+ 64
- 0
README.md View File

@@ -0,0 +1,64 @@
1
+# FSFE Website
2
+
3
+This repository contains the source files of [fsfe.org](https://fsfe.org), pdfreaders.org, freeyourandroid.org, ilovefs.org, drm.info, and test.fsfe.org.
4
+
5
+## Table of Contents
6
+
7
+* Technical information
8
+* Structure
9
+* Contribute
10
+* Translate
11
+* Build
12
+
13
+
14
+## Technical information
15
+
16
+Our web team has compiled some information about technology used for this website on the [Information for Webmasters](https://fsfe.org/contribute/web/) page.
17
+
18
+## Structure
19
+
20
+Most files are XHTML files organised in a rather logical folder structure. 
21
+
22
+### Important folders
23
+
24
+Notable directories are:
25
+
26
+* `about`: Information about the FSFE itself, its team members etc
27
+* `at`, `de`, `ee` etc: Folders used for the FSFE country teams
28
+* `build`: Mostly custom Bash and XSL scripts to build the website
29
+* `cgi-bin`: Our very few CGI scripts
30
+* `error`: Custom 4xx and 5xx error pages
31
+* `events`: Files for our events, ordered by year
32
+* `graphics`: Icons, pictures and logos
33
+* `internal`: Forms used mostly by FSFE staff for internal processes
34
+* `look`: CSS and other style files
35
+* `news`: Files for news articles, press releases, and newsletters ordered by year
36
+* `order`: Our web shop
37
+* `picturebase`: Central directory for pictures we use
38
+* `scripts`: JavaScript files used on our pages
39
+* `tags`: Files necessary to display used tags throughout the website. Mostly automatically generated
40
+* `tools`: Contains miscellaneous XML, XSL, and SH files. Most notably it contains the static translated texts (strings).
41
+
42
+### Other domains
43
+
44
+This repository also contains the source files of other websites the FSFE hosts:
45
+
46
+* `campaigns/android` for [freeyourandroid.org](http://freeyourandroid.org)
47
+* `campaigns/ilovefs` for [ilovefs.org](http://ilovefs.org)
48
+* `drm.info` for [drm.info](http://drm.info)
49
+* `pdfreaders` for [pdfreaders.org](http://pdfreaders.org)
50
+* [test.fsfe.org](http://test.fsfe.org) is build from the test branch of this repository
51
+
52
+## Contribute
53
+
54
+Become member of our awesome [webmaster team](https://fsfe.org/contribute/web/) and help improving our online information platform! The [web teams wiki page](https://wiki.fsfe.org/Teams/Web) contains info how to join the mailing list, where a issue tracker can be found, and how to edit the website's source code.
55
+
56
+## Translate
57
+
58
+We adore our voluntary translators who make information about Free Software available over 30 languages, from Arabic to Turkish!
59
+
60
+Join them to spread the message of our community in all over Europe and beyond. The [translators team page](https://fsfe.org/contribute/translators/) will introduce you to its work.
61
+
62
+## Build
63
+
64
+You can build the fsfe.org website on your own computer to make previews of single pages possible offline and without having to wait for an online website build. A [dedicated wiki page](https://wiki.fsfe.org/TechDocs/Mainpage/BuildLocally) tells you how to do it.

Loading…
Cancel
Save