aljaz/cryptoanarchywiki.github.io
1
0
Fork 0
mirror of https://github.com/aljazceru/cryptoanarchywiki.github.io.git synced 2025-12-17 05:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add style guide to REAME.md

Browse Source
This commit is contained in:
Thomas Busby
2018-05-29 01:04:54 +02:00
parent ea1d507e3a
commit c927e2ea0a
1 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -3,7 +3,7 @@
If you're reading this, then it means that you're interested in contributing to [cryptoanarchy.wiki](https://cryptoanarchy.wiki). If you'd just like to view the site then please click [here](https://cryptoanarchy.wiki). If you're reading this, then it means that you're interested in contributing to [cryptoanarchy.wiki](https://cryptoanarchy.wiki). If you'd just like to view the site then please click [here](https://cryptoanarchy.wiki).
## For the Very Non-technical: ## For the Very Non-Technical:
Set up a github account, go to the "Issues" tab above and leave an issue with instructions on what information you'd like to see added to the repository, what corrections you'd like to make, etc. Set up a github account, go to the "Issues" tab above and leave an issue with instructions on what information you'd like to see added to the repository, what corrections you'd like to make, etc.
## Basic Information ## Basic Information
@@ -16,3 +16,22 @@ The site works primarily via [Jekyll Collections](https://jekyllrb.com/docs/coll
+ **Section** - This is for items that should be displayed in the hompage contents. There is a collection for each section on the homepage. The items within the collection form the list items below the header. + **Section** - This is for items that should be displayed in the hompage contents. There is a collection for each section on the homepage. The items within the collection form the list items below the header.
+ **Subsection** - This is for content which is to be listed on a section item's page (i.e. the page of a specific instance of the collection type above). An example of this type would be the "people" collection. Some of the items in this collection would be found on the "Early Cypherpunks" page. + **Subsection** - This is for content which is to be listed on a section item's page (i.e. the page of a specific instance of the collection type above). An example of this type would be the "people" collection. Some of the items in this collection would be found on the "Early Cypherpunks" page.
## Style Guide
### Spelling conventions
I use British spelling conventions because that's what I grew up with. For the sake of keeping the site internally consistent, I may ask you to "correct" your spellings to British spellings for any content you submit.
### Dates formats
Exact dates should be given in the following format: 31-Oct-2008. This is because this format is unambigious when accounting for US vs inernational date standards. Always use three-letter months. Other date formats I'll accept are:
+ 1990s (for a broad period of time without clear beginnings and ends)
+ Aug-Sep 2013 (for a month-to-month range in the same year)
+ Aug 2013-Sep 2015 (for a month-to-month range in different years)
+ 2008/2009 (for an ongoing period of time with an unclear start date - i.e. was Bitcoin created by the genesis block, or the announcement of the white paper?)
For new content that I create (i.e. that not directly imported from cypherpunk-research) I have started marking this with the date when they were true. For example:
> Wikipedia defines "[Cypherpunk](https://en.wikipedia.org/wiki/Cypherpunk)" as follows (2018-05-26)
In this instance I use (YYYY-MM-DD) because it's the shortest non-internationally-ambiguous date format.