HelloZeroNet
/
ZeroNet
mirror of https://github.com/HelloZeroNet/ZeroNet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated ZeroNet Developer Documentation (markdown)

ZeroNet 2015-01-17 20:20:23 +01:00
parent e007be1600
commit d4ec6a1a48
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ZeroNet-Developer-Documentation.md

@ -31,8 +31,8 @@ window.my_site = new MySite()
- Load your site, the coffee script will be auto compiled to js and merged to all.js
## Coding standards for modify source code
- Use tabs instead of spaces
## Coding standards if you want to modify the source code
- Use tabs instead of spaces (tab size: 4)
- Comments starts with # Capitalized word
- Simple is better than complex
- Premature optimization is the root of all evil
@ -40,7 +40,7 @@ window.my_site = new MySite()
### Naming
- ClassNames: Capitalized, CamelCased
- functionNames: starts with lowercase, camelCased
- variable_name: lowercased, under_scored
- variable_names: lowercased, under_scored
### Variables
- file_path: File path realtive to working dir (data/17ib6teRqdVgjB698T4cD1zDXKgPqpkrMg/css/all.css)
@ -50,4 +50,4 @@ window.my_site = new MySite()
### Source files directories and naming
- One class per file is preferred
- Source file name and directory comes from ClassName: WorkerManager class = Worker/WorkerManager.py
- Source file name and directory comes from ClassName: WorkerManager class = Worker/WorkerManager.py