diff --git a/.gitattributes b/.gitattributes index afbb2c0..d1a00e1 100644 --- a/.gitattributes +++ b/.gitattributes @@ -36,47 +36,33 @@ Makefile text eol=lf encoding=utf-8 *.vcxproj.filters text eol=crlf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 *.vcxproj.user text eol=crlf encoding=utf-8 whitespace=trailing-space,space-before-tab,tabwidth=4 -#Don't let git screw with pdf files -*.pdf -text - # Force binary files to be binary -*.gif -textn -diff -*.jpg -textn -diff -*.jepg -textn -diff -*.png -textn -diff -*.webp -textn -diff -############################################################################### -# Set default behavior for command prompt diff. -# -# This is need for earlier builds of msysgit that does not have it on by -# default for csharp files. -# Note: This is only used by command line -############################################################################### -#*.cs diff=csharp +# Archives +*.7z filter=lfs diff=lfs merge=lfs -text +*.br filter=lfs diff=lfs merge=lfs -text +*.gz filter=lfs diff=lfs merge=lfs -text +*.tar filter=lfs diff=lfs merge=lfs -text +*.zip filter=lfs diff=lfs merge=lfs -text -############################################################################### -# Set the merge driver for project and solution files -# -# Merging from the command prompt will add diff markers to the files if there -# are conflicts (Merging from VS is not affected by the settings below, in VS -# the diff markers are never inserted). Diff markers may cause the following -# file extensions to fail to load in VS. An alternative would be to treat -# these files as binary and thus will always conflict and require user -# intervention with every merge. To do so, just uncomment the entries below -############################################################################### -#*.sln merge=binary -#*.csproj merge=binary -#*.vbproj merge=binary -#*.vcxproj merge=binary -#*.vcproj merge=binary -#*.dbproj merge=binary -#*.fsproj merge=binary -#*.lsproj merge=binary -#*.wixproj merge=binary -#*.modelproj merge=binary -#*.sqlproj merge=binary -#*.wwaproj merge=binary +# Documents +*.pdf filter=lfs diff=lfs merge=lfs -text + +# Images +*.gif filter=lfs diff=lfs merge=lfs -text +*.ico filter=lfs diff=lfs merge=lfs -text +*.jpg filter=lfs diff=lfs merge=lfs -text +*.jpeg filter=lfs diff=lfs merge=lfs -text +*.pdf filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text +*.psd filter=lfs diff=lfs merge=lfs -text +*.webp filter=lfs diff=lfs merge=lfs -text + +# Fonts +*.woff2 filter=lfs diff=lfs merge=lfs -text + +# Other +*.exe filter=lfs diff=lfs merge=lfs -text ############################################################################### # diff behavior for common document formats diff --git a/README.html b/README.html index f42bdb7..b4c8405 100644 --- a/README.html +++ b/README.html @@ -138,41 +138,49 @@ build the program and run unit test for the first time, launch the Visual Studio X64 native tools command prompt in the cloned directory, then:
winConfigure.bat
Should the libraries change in a subsequent pull
you will need
pull -f --recurse-submodules
+git pull
+rem you get a status message indicating libraries have been updated.
+git pull -force --recurse-submodules
winConfigure.bat
-winConfigure.bat also configures the repository you just created to use
+
in order to rebuild the libraries.
+The --force
is necessary, because winConfigure.bat
changes
+many of the library files, and therefore git will abort the pull.
+winConfigure.bat
also configures the repository you just created to use
.gitconfig
in the repository, causing git to to implement GPG signed
commits – because cryptographic software is under attack from NSA
-entryists, and shills, who seek to introduce backdoors.
+entryists and shills, who seek to introduce backdoors.
This may be inconvenient if you do not have gpg
installed and set up.
.gitconfig
adds several git aliases:
git lg
to display the gpg trust information for the last four commits.
For this to be useful you need to import the repository public key
public_key.gpg
into gpg, and locally sign that key.
-git fixws
to standardise white space to the project standards
-git graph
to graph the commit tree
+git graph
to graph the commit tree with signing status
git alias
to display the git aliases.
-# To verify that the signature on future pulls is unchanged.
-gpg --import public_key.gpg
-gpg --lsign 096EAE16FB8D62E75D243199BC4482E49673711C
-# We ignore the Gpg Web of Trust model and instead use
-# the Zooko identity model.
-# We use Gpg signatures to verify that remote repository
-# code is coming from an unchanging entity, not for
-# Gpg Web of Trust. Web of Trust is too complicated
-# and too user hostile to be workable or safe.
-# Never --sign any Gpg key related to this project. --lsign it.
-# Never check any Gpg key related to this project against a
-# public gpg key repository. It should not be there.
-# Never use any email address on a gpg key related to this project
-# unless it is only used for project purposes, or a fake email,
-# or the email of an enemy.
+# To verify that the signature on future pulls is
+# unchanged.
+gpg --import public_key.gpg
+gpg --lsign 096EAE16FB8D62E75D243199BC4482E49673711C
+We ignore the Gpg Web of Trust model and instead use the Zooko
+identity model.
+We use Gpg signatures to verify that remote repository code
+is coming from an unchanging entity, not for Gpg Web of Trust. Web
+of Trust is too complicated and too user hostile to be workable or safe.
+Never –sign any Gpg key related to this project. –lsign it.
+Never check any Gpg key related to this project against a public
+gpg key repository. It should not be there.
+Never use any email address on a gpg key related to this project
+unless it is only used for project purposes, or a fake email, or the
+email of an enemy. We don’t want Gpg used to link different email
+addresses as owned by the same entity, and we don’t want email
+addresses used to link people to the project, because those
+identities would then come under state and quasi state pressure.
To build the documentation in its intended html form from the markdown
files, execute the bash script file docs/mkdocs.sh
, in an environment where
-pandoc
is available. On Windows, if Git Bash and Pandoc has been
-installed, you should be able to run a shell file in bash by double clicking on it.
+pandoc
is available. On Windows, if Git Bash and Pandoc
+has been installed, you should be able to run this shell
+file in bash by double clicking on it.
Pre alpha release, which means it does not yet work even well enough for
it to be apparent what it would do if it did work.