From 9396d52b429dc5fbeeb78dbbe382a9ef9567a820 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Sun, 15 Dec 2013 16:57:51 +0000 Subject: [PATCH] Docs updates --- contributing.md | 4 ++-- readme.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contributing.md b/contributing.md index 36240e3cc..b29597b02 100644 --- a/contributing.md +++ b/contributing.md @@ -1,8 +1,8 @@ -

Contributing to TiddlyWiki5

TiddlyWiki5 welcomes contributions to its code and documentation via GitHub. Please take a moment to read these notes to help make the process as smooth as possible.

Bug Reports

From the perspective of the developers, a bug report that says little more than "it doesn't work" can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:

There's a lot of good material on the web about bug reports:

Pull Requests

Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).

This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again

How to sign the CLA

git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5
+
Contributing to TiddlyWiki5
TiddlyWiki5 welcomes contributions to its code and documentation via GitHub. Please take a moment to read these notes to help make the process as smooth as possible.
Bug Reports
From the perspective of the developers, a bug report that says little more than "it doesn't work" can be frustrating. For effective debugging, we need as much information as possible. At a minimum, please try to include:
There's a lot of good material on the web about bug reports:
Pull Requests
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors before contributions of code can be accepted. This is a legal agreement that allows contributors  to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
This is a first pass at a CLA for TiddlyWiki. Please let us know if we missed something important. If we do have to make essential changes to the CLA, there is a possibility that all contributors will need to sign it again
How to sign the CLA
git clone https://github.com/Jermolene/TiddlyWiki5.git TiddlyWiki5
 cd TiddlyWiki5
 git checkout -b sign-cla
Add your name and the date to cla-individual.md or cla-entity.md. Date format (YYYY/MM/DD)
 eg: Jeremy Ruston, @Jermolene, 2011/11/22
git add .
 git commit -m "sign contributor license agreement"
 git push origin sign-cla
Go to your github repo and create a pull request.
Thank you!
Attribution
The CLA documents used for this project where created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity"
-
This file was automatically generated by TiddlyWiki5
+
This file was automatically generated by TiddlyWiki5
 

\ No newline at end of file
diff --git a/readme.md b/readme.md
index 6341b176e..2936b2eac 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,3 @@
-
Welcome to TiddlyWiki5
Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
This is version 5.0.3-prerelease of TiddlyWiki, a major reboot designed for the next 25 years. It is currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.
TiddlyWiki is a free, open source project that depends on your love and support for their survival.
TiddlyWikiClassic - http://classic.tiddlywiki.com
On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and TiddlyWikiClassic is used to identify the older version.
The deep internal improvements mean that the new version of TiddlyWiki is not fully compatible with TiddlyWikiClassic. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as the new version matures.
-
Getting started with TiddlyWiki under Node.js
This readme file was automatically generated by TiddlyWiki5
+
Welcome to TiddlyWiki5
Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
This is version 5.0.3-prerelease of TiddlyWiki, a major reboot designed for the next 25 years. It is currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.
TiddlyWiki is a free, open source project that depends on your love and support for their survival.
TiddlyWikiClassic - http://classic.tiddlywiki.com
On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and TiddlyWikiClassic is used to identify the older version.
The deep internal improvements mean that the new version of TiddlyWiki is not fully compatible with TiddlyWikiClassic. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as the new version matures.
+
Getting started with TiddlyWiki under Node.js
This readme file was automatically generated by TiddlyWiki5
 

\ No newline at end of file