Make README more standard-compliant

lektura
max.mehl 2017-09-14 15:36:21 +02:00
parent 8696fa2648
commit ebacf72cb6
1 changed files with 36 additions and 10 deletions

View File

@ -1,13 +1,23 @@
# PMPC Web Site # Public Money Public Code Source of publiccode.eu
[![Build Status](https://drone.fsfe.org/api/badges/pmpc/website/status.svg)](https://drone.fsfe.org/pmpc/website) [![Build Status](https://drone.fsfe.org/api/badges/pmpc/website/status.svg)](https://drone.fsfe.org/pmpc/website)
This website is the core of the "Public Money, Public Code" campaign. It is This website is the core of the "Public Money, Public Code" campaign. It is based on [Hugo](https://gohugo.io), a modern static website generator.
based on [Hugo](https://gohugo.io/), a modern static website generator.
The page is visible at [publiccode.eu](https://publiccode.eu). The page is visible at [publiccode.eu](https://publiccode.eu).
## Contributing to the website
## Table of Contents
- [Translate](#translate)
- [Contribute](#contribute)
- [Build](#build)
- [HowTos and FAQs](#howtos-and-faqs)
- [Maintainers](#maintainers)
- [License](#license)
## Contribute
### Prerequisites ### Prerequisites
@ -17,6 +27,7 @@ computer. If Hugo isn't available in your package manager, obtain it from its
from version 0.20.7 upwards. Please make sure that you use an as recent version from version 0.20.7 upwards. Please make sure that you use an as recent version
as possible to avoid errors. as possible to avoid errors.
### Configuring Git ### Configuring Git
First of all, you'll need an account on git.fsfe.org. In the FSFE's wiki, First of all, you'll need an account on git.fsfe.org. In the FSFE's wiki,
@ -28,6 +39,7 @@ As part of the campaign team you can get full write access to this repository.
Please contact one of [pmpc](https://git.fsfe.org/pmpc)'s admins to give your Please contact one of [pmpc](https://git.fsfe.org/pmpc)'s admins to give your
account the necessary privileges. account the necessary privileges.
### Cloning the website ### Cloning the website
Although the mentioned Git guides will enable you to understand how to download Although the mentioned Git guides will enable you to understand how to download
@ -46,12 +58,14 @@ website consists of now. The hugo files are located under `site/`, whereas in
the root directory you'll only find files informational files and those the root directory you'll only find files informational files and those
relevant for our build process (Drone, Ansible, Docker, Apache). relevant for our build process (Drone, Ansible, Docker, Apache).
### Translate
## Translate
Visit [TRANSLATE.md](https://git.fsfe.org/pmpc/website/src/master/TRANSLATE.md) Visit [TRANSLATE.md](https://git.fsfe.org/pmpc/website/src/master/TRANSLATE.md)
for detailed instructions how to translate publiccode.eu. for detailed instructions how to translate publiccode.eu.
### Build
## Build
To see a preview of the website you need to have Hugo installed and be able to To see a preview of the website you need to have Hugo installed and be able to
execute Bash scripts in your command line. execute Bash scripts in your command line.
@ -93,7 +107,9 @@ by preference and complexity:
and may give you some first experience with the system. and may give you some first experience with the system.
## Important file paths ## HowTos and FAQs
### Important file paths
The website structure is very easy. The most important files and directories are: The website structure is very easy. The most important files and directories are:
@ -118,14 +134,24 @@ The website structure is very easy. The most important files and directories are
Generated by running `hugo`. Generated by running `hugo`.
## Technical information about the online build ### Add a new supporting organisation
### Technical information about the online build
The FSFE uses Drone to automatically deploy the PMPC website. The The FSFE uses Drone to automatically deploy the PMPC website. The
website is automatically deployed when there's a push to the master website is automatically deployed when there's a push to the master
branch of the repository, as well as once an hour (to update branch of the repository, as well as once an hour (to update
signatures). signatures).
This is the latest build status:
[![Build Status](https://drone.fsfe.org/api/badges/pmpc/website/status.svg)](https://drone.fsfe.org/pmpc/website) ## Maintainers
[@max.mehl](https://git.fsfe.org/max.mehl)
## License
GNU GPL 3.0+ © 2017 Free Software Foundation Europe (FSFE)