2016-02-09 20:57:44 +00:00
Replicant
=========
About
-----
Replicant is a fully free Android distribution running on several devices.
2017-04-06 22:21:41 +00:00
It is based on LineageOS and thus on the Android Open Source Project.
2016-02-09 20:57:44 +00:00
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
-------
2017-04-06 22:30:54 +00:00
Replicant is based on [LineageOS](http://lineageos.org/) which is based on the [Android Open Source Project](https://source.android.com/).
2016-02-09 20:57:44 +00:00
Contributors
------------
2017-04-06 22:21:41 +00:00
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.
2017-05-02 21:55:40 +00:00
However, a (non-exhaustive) list of people who specifically contribute(d) to Replicant is available at: <https://redmine.replicant.us/projects/replicant/wiki/People>
2016-02-09 20:57:44 +00:00
Artwork copyright
-----------------
2017-04-10 13:48:24 +00:00
Copyright 2011 Mirella Vedovetto
2016-02-09 20:57:44 +00:00
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
-----
2017-05-02 21:55:40 +00:00
Website: <https://www.replicant.us/>
Wiki/Tracker: <https://redmine.replicant.us/>
2016-02-09 20:57:44 +00:00
2016-12-27 05:49:59 +00:00
LineageOS
2017-04-06 22:21:41 +00:00
=========
2011-11-15 02:41:03 +00:00
Submitting Patches
------------------
2016-12-27 05:49:59 +00:00
Patches are always welcome! Please submit your patches via LineageOS Gerrit!
2011-11-15 02:41:03 +00:00
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>
2015-10-07 01:22:00 +00:00
repo start cm-13.0 .
2011-11-15 02:41:03 +00:00
(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>
2016-12-27 05:49:59 +00:00
To view the status of your and others' patches, visit [LineageOS Code Review](http://review.lineageos.org/)
2011-11-15 02:41:03 +00:00
Getting Started
---------------
2016-12-27 05:49:59 +00:00
To get started with Android/LineageOS, you'll need to get
2013-06-02 20:30:09 +00:00
familiar with [Git and Repo](http://source.android.com/source/using-repo.html).
2011-11-15 02:41:03 +00:00
2016-12-27 05:49:59 +00:00
To initialize your local repository using the LineageOS trees, use a command like this:
2011-11-15 02:41:03 +00:00
2016-12-27 05:49:59 +00:00
repo init -u git://github.com/LineageOS/android.git -b cm-13.0
2011-11-15 02:41:03 +00:00
Then to sync up:
repo sync
2016-12-27 05:49:59 +00:00
Please see the [LineageOS Wiki](http://wiki.lineageos.org/) for building instructions.
2011-11-15 02:41:03 +00:00
For more information on this Github Organization and how it is structured,
2016-12-27 05:49:59 +00:00
please [read the wiki article](http://wiki.lineageos.org/w/Github_Organization)
2011-11-15 02:41:03 +00:00
Buildbot
--------
All supported devices are built nightly and periodically as changes are committed to ensure the source trees remain buildable.
2016-12-27 05:49:59 +00:00
You can view the current build statuses at [LineageOS Jenkins](http://jenkins.lineageos.org/)
