From 7d0ba8401fe22e1c64cf3c1485166ba04fa37ccf Mon Sep 17 00:00:00 2001 From: Leo Horie Date: Thu, 10 Apr 2014 22:07:32 -0400 Subject: [PATCH] add docs about github --- archive/v0.1.4/installation.html | 7 +++++++ archive/v0.1.4/mithril.min.zip | Bin 21615 -> 21615 bytes docs/installation.md | 14 ++++++++++++++ 3 files changed, 21 insertions(+) diff --git a/archive/v0.1.4/installation.html b/archive/v0.1.4/installation.html index 2ab54d0b..ccc72b54 100644 --- a/archive/v0.1.4/installation.html +++ b/archive/v0.1.4/installation.html @@ -85,6 +85,13 @@
component install lhorie/mithril

Then, to use Mithril, point a script tag to the downloaded file:

<script src="/components/lhorie/mithril/master/mithril.min.js"></script>
+
+

Github

+

You can also fork the latest stable project directly from Github.

+

If you want to use the bleeding edge version, you can fork the development repository.

+

Note that Mithril uses the next branch as the stable branch, instead of master, because contributors usually use master for pull requests. Therefore, the master branch should be considered unstable, and should not be used.

+

Be aware that even though Mithril has tests running in a continuous integration environment, the bleeding edge version might occasionally break. If you're interested in helping improve Mithril, you're welcome to use the bleeding edge version and report any bugs that you find.

+

In order to update a forked version of Mithril, follow the instructions on this page.

diff --git a/archive/v0.1.4/mithril.min.zip b/archive/v0.1.4/mithril.min.zip index 50a4d74e074b1558a4852bc1528a1542c1829d19..52ae54b6639b5182e20a13a4e5b06be058030ef5 100644 GIT binary patch delta 45 vcmaFAg7N(dMxFp~W)?065O}a*Baemx(}NA0%@np71L?`{f~`Q5R){MAU!)L< delta 45 vcmaFAg7N(dMxFp~W)?065Xe}wkw-&;DPzrMGlgx&Kzj1KU@H)%72*m2KEw{1 diff --git a/docs/installation.md b/docs/installation.md index c7b1ae28..f996881a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -101,3 +101,17 @@ Then, to use Mithril, point a script tag to the downloaded file: ```markup ``` + +--- + +### Github + +You can also fork the latest stable project [directly from Github](https://github.com/lhorie/mithril). + +If you want to use the bleeding edge version, you can [fork the development repository](https://github.com/lhorie/mithril). + +Note that Mithril uses the `next` branch as the stable branch, instead of `master`, because contributors usually use `master` for pull requests. Therefore, the `master` branch should be considered unstable, and should not be used. + +Be aware that even though Mithril has tests running in a continuous integration environment, the bleeding edge version might occasionally break. If you're interested in helping improve Mithril, you're welcome to use the bleeding edge version and report any bugs that you find. + +In order to update a forked version of Mithril, [follow the instructions on this page](https://help.github.com/articles/syncing-a-fork). \ No newline at end of file