From e1327c22142325a6a0b094546f2fbf90c61c5a32 Mon Sep 17 00:00:00 2001 From: Adam Shaw Date: Thu, 5 Jun 2014 11:11:09 -0400 Subject: [PATCH] minimalize readme. new links to wiki --- changelog.md | 4 +- readme.md | 107 ++++++--------------------------------------------- 2 files changed, 14 insertions(+), 97 deletions(-) diff --git a/changelog.md b/changelog.md index d149a75b12..c48ae66359 100644 --- a/changelog.md +++ b/changelog.md @@ -5,7 +5,7 @@ v2.0.0 (2014-06-01) Internationalization support, timezone support, and [MomentJS] integration. Extensive changes, many of which are backwards incompatible. -[Full list of changes][Upgrading-to-2] | [Affected Issues][Date-Milestone] +[Full list of changes][Upgrading-to-v2] | [Affected Issues][Date-Milestone] An automated testing framework has been set up ([Karma] + [Jasmine]) and tests have been written which cover about half of FullCalendar's functionality. Special thanks to @incre-d, @vidbina, and @@ -15,7 +15,7 @@ In addition, the main development repo has been repurposed to also include the b JS/CSS for the project and will serve as the new [Bower] endpoint. [MomentJS]: http://momentjs.com/ -[Upgrading-to-2]: http://arshaw.com/fullcalendar/wiki/Upgrading-to-2/ +[Upgrading-to-v2]: http://arshaw.com/fullcalendar/wiki/Upgrading-to-v2/ [Date-Milestone]: https://code.google.com/p/fullcalendar/issues/list?can=1&q=milestone%3Ddate [Karma]: http://karma-runner.github.io/ [Jasmine]: http://jasmine.github.io/ diff --git a/readme.md b/readme.md index 8e2f4b3fe1..655e75aa4a 100644 --- a/readme.md +++ b/readme.md @@ -1,99 +1,16 @@ +# FullCalendar -FullCalendar - Full-sized drag & drop event calendar -==================================================== +A full-sized drag & drop event calendar (jQuery plugin). -This document describes how to modify or contribute to the FullCalendar project. If you are looking for end-developer documentation, please visit the [project homepage][fc-homepage]. +- [Project website and demos](http://arshaw.com/fullcalendar/) +- [Documentation](http://arshaw.com/fullcalendar/docs/) +- [Support](http://arshaw.com/fullcalendar/support/) +- [Changelog](changelog.md) +- [License](license.txt) +For contributors: -Getting Set Up --------------- - -You will need [Git][git], [Node][node], and NPM installed. For clarification, please view the [jQuery readme][jq-readme], which requires a similar setup. - -Also, you will need the [grunt-cli][grunt-cli] and [bower][bower] packages installed globally (`-g`) on your system: - - npm install -g grunt-cli bower - -Then, clone FullCalendar's git repo: - - git clone git://github.com/arshaw/fullcalendar.git - -Enter the directory and install FullCalendar's development dependencies: - - cd fullcalendar && npm install - - -Development Workflow --------------------- - -After you make code changes, you'll want to compile the JS/CSS so that it can be previewed from the tests and demos. You can either manually rebuild each time you make a change: - - grunt dev - -Or, you can run a script that automatically rebuilds whenever you save a source file: - - ./build/watch.sh - -When you are finished, run the following command to write the distributable files into the `./dist/` directory: - - grunt - -If you want to clean up the generated files, run: - - grunt clean - - -Style Guide ------------ - -Please follow the [Google JavaScript Style Guide] as closely as possible. With the following exceptions: - -```js -if (true) { -} -else { // please put else, else if, and catch on a separate line -} - -// please write one-line array literals with a one-space padding inside -var a = [ 1, 2, 3 ]; - -// please write one-line object literals with a one-space padding inside -var o = { a: 1, b: 2, c: 3 }; -``` - -Other exceptions: - -- please ignore anything about Google Closure Compiler or the `goog` library -- please do not write JSDoc comments - -Notes about whitespace: - -- use *tabs* instead of spaces -- separate functions with *2* blank lines -- separate logical blocks within functions with *1* blank line - -Run the command line tool to automatically check your style: - - grunt check - - -Before Contributing! --------------------- - -If you have edited code (including **tests** and **translations**) and would like to submit a pull request, please make sure you have done the following: - -1. Conformed to the style guide (successfully run `grunt check`) - -2. Written automated tests. View the [Automated Test README] - - - -[fc-homepage]: http://arshaw.com/fullcalendar/ -[git]: http://git-scm.com/ -[node]: http://nodejs.org/ -[grunt-cli]: http://gruntjs.com/getting-started#installing-the-cli -[bower]: http://bower.io/ -[jq-readme]: https://github.com/jquery/jquery/blob/master/README.md#what-you-need-to-build-your-own-jquery -[karma]: http://karma-runner.github.io/0.10/index.html -[Google JavaScript Style Guide]: http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml -[Automated Test README]: ./tests/automated_test_readme.md +- [Ways to contribute](http://arshaw.com/fullcalendar/wiki/Contributing/) +- [General coding guidelines](https://github.com/arshaw/fullcalendar/wiki/Contributing-Code) +- [Contributing features](https://github.com/arshaw/fullcalendar/wiki/Contributing-Features) +- [Contributing bugfixes](https://github.com/arshaw/fullcalendar/wiki/Contributing-Bugfixes) \ No newline at end of file