aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDenis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>2021-04-27 16:28:12 +0200
committerDenis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>2021-04-27 16:29:18 +0200
commit90f007a2f104b3162098517c5d4f47bf3e026189 (patch)
tree8541d7292eabe55e43c3e180cd8640446235cf9c
parent15b0c0801d6d7155471389e3b9d4c1648b76fe80 (diff)
downloadmanifest-master.tar.gz
manifest-master.tar.bz2
manifest-master.zip
Add README for the master branchmaster
It seems that the newer repos don't like the fact that our manifest repository doesn't have a master branch: manifests: fatal: couldn't find remote ref refs/heads/master So this commit adds one with a README inside (which was taken from the replicant-6.0-0004-rc5 tag. Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
-rw-r--r--README.mkdn89
1 files changed, 89 insertions, 0 deletions
diff --git a/README.mkdn b/README.mkdn
new file mode 100644
index 0000000..792f066
--- /dev/null
+++ b/README.mkdn
@@ -0,0 +1,89 @@
+Replicant
+=========
+
+About
+-----
+
+Replicant is a fully free Android distribution running on several devices.
+It is based on LineageOS and thus on the Android Open Source Project.
+
+Android includes software from various sources, released under different free software licenses.
+Replicant attempts to remove or replace any non-free component (running on the main CPU) that is needed by Android, whenever this is possible.
+
+We are not experts in embedded devices, just a couple enthusiastic hackers that are giving a try.
+
+Credits
+-------
+
+Replicant is based on [LineageOS](http://lineageos.org/) which is based on the [Android Open Source Project](https://source.android.com/).
+
+Contributors
+------------
+
+The full list of contributors to the Replicant code base must be very long since it is based on LineageOS and AOSP, which are both using third party projects.
+However, a (non-exhaustive) list of people who specifically contribute(d) to Replicant is available at: <https://redmine.replicant.us/projects/replicant/wiki/People>
+
+Artwork copyright
+-----------------
+
+Copyright 2011 Mirella Vedovetto
+Copyright 2012 Paul Kocialkowski
+
+This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
+
+Links
+-----
+
+Website: <https://www.replicant.us/>
+Wiki/Tracker: <https://redmine.replicant.us/>
+
+LineageOS
+=========
+
+Submitting Patches
+------------------
+Patches are always welcome! Please submit your patches via LineageOS Gerrit!
+You can do this by using these commands:
+
+ (From root android directory)
+ . build/envsetup.sh
+ (Go to repo you are patching, make your changes and commit)
+ cmgerrit <for(new)/changes(patch set)> <branch/change-id>
+
+ repo start cm-13.0 .
+ (Make your changes and commit)
+ repo upload .
+Note: "." meaning current directory
+For more help on using this tool, use this command: repo help upload
+
+Make your changes and commit with a detailed message, starting with what you are working with (i.e. vision: Update Kernel)
+Commit your patches in a single commit. Squash multiple commit using this command: git rebase -i HEAD~<# of commits>
+
+To view the status of your and others' patches, visit [LineageOS Code Review](http://review.lineageos.org/)
+
+
+Getting Started
+---------------
+
+To get started with Android/LineageOS, you'll need to get
+familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
+
+To initialize your local repository using the LineageOS trees, use a command like this:
+
+ repo init -u git://github.com/LineageOS/android.git -b cm-13.0
+
+Then to sync up:
+
+ repo sync
+
+Please see the [LineageOS Wiki](http://wiki.lineageos.org/) for building instructions.
+
+For more information on this Github Organization and how it is structured,
+please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization)
+
+Buildbot
+--------
+
+All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
+
+You can view the current build statuses at [LineageOS Jenkins](http://jenkins.lineageos.org/)