missytake/fdroiddata
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Move quickstart docs to README

Browse source
This commit is contained in:
Daniel Martí 2015-08-18 17:11:01 -07:00
parent 1e41bfcaf9
commit 6b286e1795
2 changed files with 26 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md
View file

@ -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 * [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 ### Setting up fdroiddata for merge requests
* [Register on GitLab](http://gitlab.com) * [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: * Follow the [Quickstart](README.md#quickstart), but using the url
`git@gitlab.com:yourusername/fdroiddata.git` when cloning
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
### Adding a new app ### Adding a new app

35
README.md
View file

@ -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) [![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 This repository holds general and build information for all the apps on our
main repo on f-droid.org. main repo on f-droid.org.
Quickstart ## Quickstart
----------
First, you need [fdroidserver](https://gitlab.com/fdroid/fdroidserver). Once * Clone [fdroidserver](https://gitlab.com/fdroid/fdroidserver):
you have `fdroid` installed, you can start using it.
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/). You can find more details on [the manual](https://f-droid.org/manual/).