From 6b286e1795f5a37fc940b6f88ac3b4503baed183 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Tue, 18 Aug 2015 17:11:01 -0700 Subject: [PATCH] Move quickstart docs to README --- CONTRIBUTING.md | 29 +++-------------------------- README.md | 35 +++++++++++++++++++++++------------ 2 files changed, 26 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1749ca180c..9b7a811b6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,37 +18,14 @@ about apps that can no longer be built will be closed. * [Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) your commits -### Setting up fdroidserver - -* Clone [fdroidserver](https://gitlab.com/fdroid/fdroidserver): - - git clone https://gitlab.com/fdroid/fdroidserver - -* Add the cloned dir to your `PATH`: - - export PATH="$PATH:~/fdroidserver - ### Setting up fdroiddata for merge requests * [Register on GitLab](http://gitlab.com) -* Visit and fork the [fdroiddata repository](https://gitlab.com/fdroid/fdroiddata/) +* Visit and fork the [fdroiddata repository](https://gitlab.com/fdroid/fdroiddata) -* Clone your fdroiddata fork: - - git clone git@gitlab.com:username/fdroiddata.git - -* Enter it: - - cd fdroiddata - -* An empty configuration file should work as a start: - - touch config.py - -* Make sure fdroid works and reads the metadata files properly: - - fdroid readmeta +* Follow the [Quickstart](README.md#quickstart), but using the url + `git@gitlab.com:yourusername/fdroiddata.git` when cloning ### Adding a new app diff --git a/README.md b/README.md index f2beb3e034..d932dc3e99 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,36 @@ -F-Droid Data -============ +# F-Droid Data [![Build status](https://ci.gitlab.com/projects/5274/status.png?ref=master)](https://ci.gitlab.com/projects/5274?ref=master) This repository holds general and build information for all the apps on our main repo on f-droid.org. -Quickstart ----------- +## Quickstart -First, you need [fdroidserver](https://gitlab.com/fdroid/fdroidserver). Once -you have `fdroid` installed, you can start using it. +* Clone [fdroidserver](https://gitlab.com/fdroid/fdroidserver): -For most setups, an empty config.py will be sufficient - `touch config.py`. + git clone https://gitlab.com/fdroid/fdroidserver -Contributing ------------- +* Add the cloned dir to your `PATH`: -See the [contributing guidelines](CONTRIBUTING.md). + export PATH="$PATH:$PWD/fdroidserver -More information ----------------- +* Enter it: + + cd fdroiddata + +* An empty configuration file should work as a start: + + touch config.py + +* Make sure fdroid works and reads the metadata files properly: + + fdroid readmeta + +## Contributing + +See the [Contributing](CONTRIBUTING.md) doc. + +## More information You can find more details on [the manual](https://f-droid.org/manual/).