oeed / CraftOS-Standards

Community standard file formats, communication systems, etc. for ComputerCraft and CraftOS 2.0
Other
20 stars 14 forks source link

How to Propose a Standard (Tutorial) #13

Closed viluon closed 8 years ago

viluon commented 8 years ago

A tutorial to get you started (currently work in progress). I am planning on moving tutorial-like stuff from the README into the new tutorial directory. What do you think?

oeed commented 8 years ago

I'd propose mentioning a standard way to express file trees.

I suggest using = for folders and - for files and placing it within a code block, like this:

= documents
    - image.ucg
    - readme.txt
    = code
        - paint.lua
= system
    - startup
oeed commented 8 years ago

How do you differentiate files and folders though if the folder is empty?

viluon commented 8 years ago

Nice suggestion @oeed, I like it better than yours @demhydraz, sorry :stuck_out_tongue: I'll add it to the guide.

viluon commented 8 years ago

@oeed use space or tab indent for the directory tree? I'd suggest tab indentation.

viluon commented 8 years ago

:+1:

oeed commented 8 years ago

Yeah tabs, might've just been my Markdown editor (not Sublime this time).

viluon commented 8 years ago

Finally resolved conflicts with master.

oeed commented 8 years ago

I'll leave this branch undeleted if there's anything you want to add @viluon, but otherwise feel free to delete it.