summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Warren <swarren@nvidia.com>2015-02-24 15:43:08 -0700
committerStephen Warren <swarren@nvidia.com>2015-02-25 15:58:59 -0700
commit9ca8d038ffc05b21d205105ddd6a6d42758508d3 (patch)
tree7948da5c47b796819c5fc96181d861a57c506d47
parentb54bdc46b51ecb0971aa495b0fdd5ef884ccd48d (diff)
downloadtegra-uboot-flasher-scripts-9ca8d038ffc05b21d205105ddd6a6d42758508d3.tar.gz
Add a README file
A plain README.txt is a more commit name for a README file than the existing README-*.txt files. This will help direct users to the correct file they need to read. Also add a section describing how/where to send patches, etc. Signed-off-by: Stephen Warren <swarren@nvidia.com>
-rw-r--r--README-developer.txt22
-rw-r--r--README.txt9
2 files changed, 31 insertions, 0 deletions
diff --git a/README-developer.txt b/README-developer.txt
index e2648c3..4372d64 100644
--- a/README-developer.txt
+++ b/README-developer.txt
@@ -62,6 +62,28 @@ repo init -u ... -g default,-notools
# Only include the bare minimum
repo init -u ... -g default,-notools,-bootloader
+Submitting Changes
+==================
+
+To submit patches to this project, please use the following commands:
+
+* git format-patch --subject-prefix="flasher scripts PATCH"
+
+ Creates a patch file from your git commit.
+
+* git send-email --to linux-tegra@vger.kernel.org *.patch
+
+ Sends the patch by email to the Tegra mailing list.
+
+Even though the primary upstream repository for this project is hosted on
+github, contributions aren't accepted via github pull requests. Github pull
+requests would bypass public code review on the project mailing list.
+
+Patches should be signed off (include a signed-off-by line) to indicate your
+acceptance of the code's license (see COPYING and the license header in each
+file). See http://developercertificate.org/ for details of what signed-off-by
+implies.
+
Pre-requisites
==============
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..3bba5c2
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,9 @@
+Introduction
+============
+
+If you want to download the source to this tool and compile it, or submit
+changes to this tool, see README-developer.txt.
+
+If you want to use this tool either after having compiled it yourself, or
+after having received a pre-compiled version from someone else (e.g. a
+distribution packager), see README-user.txt