Arakade / dartblanklib

A starting spot for a dart library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

dartblanklib

A starting spot for a dart library.

Why?

As I was building dartlib I realized there were few other examples of dart libraries. I was making up conventions (directory names, etc) as I went along based on my experience with Ruby/Gems and node.js among others.

How to

If you want to build a new library, I'd suggest downloading the contents of the project and putting them in a new directory. From there you can do git init and start from scratch.

If you want to contribute tweaks, fixes, or documentation to dartblanklib then clone the repository.

Structure

readme.md

All projects should have one. You should delete the contents out of this one and start from scratch.

The `md` extension means Markdown which github parses nicely.

Although <table> support is not ideal.

pubspec A place to put external dependencies. See the notes in the file.
lib/ See readme.me in the lib directory.
test/ See readme.me in the test directory.
vendor/ See readme.me in the vendor directory.
samples/ ...todo...
bin/ ...todo...

Authors

The BSD 2-Clause License

Copyright (c) 2012, dartlblankib project authors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.

About

A starting spot for a dart library