Merge branch 'master' of https://git.bettercrypto.org/ach-master
authorAaron Kaplan <aaron@lo-res.org>
Mon, 2 Dec 2013 20:04:19 +0000 (21:04 +0100)
committerAaron Kaplan <aaron@lo-res.org>
Mon, 2 Dec 2013 20:04:19 +0000 (21:04 +0100)
FAQ.md
README.md

diff --git a/FAQ.md b/FAQ.md
index 596a441..b064fd5 100644 (file)
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,29 +1,40 @@
-FAQ
-=====
+FAQ
+-----
 
 Q: I want to review the document. What do I need to do?
-A: git clone the document, make changes, send us a diff
-Do not forget to add your name to reviewers.tex !! 
+
+A: `git clone` the document, make changes, send us a diff
+Do not forget to add your name to `reviewers.tex`!
+
 
 
 Q: Who is invited to review the document?
+
 A: Essentially everyone. The core group of editors consists of crypologists,
-computer scientists and sysadmins
+computer scientists and sysadmins.
+
 
 Q: Where is the repository?
+
 A: https://git.bettercrypto.org/ach-master.git
 
 
 Q: Where is the mailing list?
+
 A: http://lists.cert.at/cgi-bin/mailman/listinfo/ach
 
+
 Q: Can anyone subscribe to the list?
+
 A: yes
 
 
-Q: I found a bug / some of your recommendations does not work for me
-A: Please get in contact with us on the mailing list
+Q: I found a bug / some of your recommendations do not work for me
+
+A: Please get in contact with us on the mailing list!
+
 
 Q: Is there a webpage?
-A: yes, www.bettercrypto.org
+
+A: yes, bettercrypto.org
 
index 0f3ca9f..f3f9df5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,33 +1,36 @@
-HOW TO USE THIS 
-===============
+HOW TO USE THIS 
+-----------------
 
-Anonymous (read-only) git cloning::
+Anonymous (read-only) git cloning:
 
-  $ git clone  https://git.bettercrypto.org/ach-master.git
+`  $ git clone  https://git.bettercrypto.org/ach-master.git`
 
 
-As a registered user::
+As a registered user:
 
-  $ git clone  https://<myuser>@git.bettercrypto.org/ach-master.git
+  `$ git clone  https://<myuser>@git.bettercrypto.org/ach-master.git`
 
-where <myuser> is your username on the server. Ask for write permissions if you need them.
+Where `<myuser>` is your username on the server. Ask for write permissions if you need them.
 
 
 Committing changes you made (from within repo-directory)::
 
-  $ git commit -a
-  $ git push origin master
+
+```
+$ git commit -a
+$ git push origin master
+```
 
 
 Receive latest updates for a previously cloned repository (from within repo-directory)::
 
-  $ git pull
+  `$ git pull`
 
 
 
-IMPORTANT
-=========
+IMPORTANT
+-----------
 
-If you reviewed the document and/or made some changes, please please add your name to the reviewers.tex file (the list of names is sorted alphabetically by last name).
+If you reviewed the document and/or made some changes, please please add your name to the `reviewers.tex` file (the list of names is sorted alphabetically by last name).
 
 Please also read the FAQ!!