Merge pull request #393 from casperklein/patch-1
[ach-master.git] / README.md
1 # WARNING: This document has some outdated content and should be used with care.
2 ## There may be a new version of this document in the future. However at the moment the recommendations in this document do not in all cases reflect up to date crypto configuration examples and do include some recommendations that can weaken security.
3
4 First off: you are welcome to help us! Every reviewer, committer and person interested in discussing our document and changes is a valuable addition to the project. Everybody is invited to work on this document and share their experience and expertise with us or ask questions if something isn't clear to them. Please read [CONTRIBUTING](CONTRIBUTING.md) document for more information.
5
6 # HOW TO USE THIS
7
8 ## git.bettercrypto.org
9 Anonymous (read-only) git cloning:
10
11 `  $ git clone  https://git.bettercrypto.org/ach-master.git`
12
13
14 As a registered user:
15
16   `$ git clone  https://<myuser>@git.bettercrypto.org/ach-master.git`
17
18 Where `<myuser>` is your username on the server. Ask for write permissions if you need them.
19
20
21 Committing changes you made (from within repo-directory):
22
23
24 ```
25 $ git commit -a
26 $ git push origin master
27 ```
28
29
30 Receive latest updates for a previously cloned repository (from within repo-directory):
31
32   `$ git pull`
33
34 ## GitHub
35 Fork and issue pull requests. Those will be reviewed and if accepted pushed to the main repository hosted on git.bettercrypto.org.
36
37 ## MacTeX
38 MacTeX misses `mweights.sty` and may cause a compile error.
39
40 ```bash
41 sudo tlmgr install mweights
42 ```
43
44 ## IRC
45 channel: #bettercrypto
46 network: freenode
47
48 # IMPORTANT
49
50  * If you reviewed the document and/or made some changes, please add your name to `src/acknowledgements.tex` (the list of names is sorted alphabetically by last name).
51  * Send many smaller commits (pull requests) and not one big one! Big ones tend to be delayed. It's hard to process a huge commit. We need to review everything, please remember.
52  * Please also read the [FAQ](FAQ.md)!!