Skip to content
This repository has been archived by the owner on Apr 16, 2019. It is now read-only.

Commit

Permalink
Update README.md again
Browse files Browse the repository at this point in the history
Move discontinuation statement to top, remove Contribute section
  • Loading branch information
tony-- committed May 22, 2017
1 parent e3b7589 commit 724d7e9
Showing 1 changed file with 3 additions and 55 deletions.
58 changes: 3 additions & 55 deletions README.md
@@ -1,10 +1,10 @@
DISCONTINUATION OF PROJECT. This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. In an effort to support the developer community, Intel has made this project available under the terms of the MIT X11 License. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

# App Framework - a HTML5 targeted Javascript Framework # App Framework - a HTML5 targeted Javascript Framework


App Framework is a UI framework targeted at HTML5 browsers. App Framework is a UI framework targeted at HTML5 browsers.


DISCONTINUATION OF PROJECT. This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. In an effort to support the developer community, Intel has made this project available under the terms of the MIT X11 License. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project. # 3.0 version

#3.0 version


The 3.0 version of App Framework removes the following The 3.0 version of App Framework removes the following


Expand All @@ -13,58 +13,6 @@ The 3.0 version of App Framework removes the following
3. No longer provides a "Touchlayer", use Fastclick (https://github.com/ftlabs/fastclick) instead. 3. No longer provides a "Touchlayer", use Fastclick (https://github.com/ftlabs/fastclick) instead.
4. Native scrolling is only used. If you need a JS scroller, use an existing one like FTScroller (https://github.com/ftlabs/ftscroller) or iScroll 4. Native scrolling is only used. If you need a JS scroller, use an existing one like FTScroller (https://github.com/ftlabs/ftscroller) or iScroll


##Note
You can still use App Framework 2 if you need Android <4 support or the query selector library. The old query selector library *may* work with AF 3.0, but we do not test or support it.

# Contribute

You can contribute to the core code by forking it and make a pull request. Please keep in mind we do not want to add functionality that is a one-off case. These are best dealt with via plugins.

You can make changes to any of the files in the "src" directory



#Building

We use Grunt to build our compiled files. When you have made a change, run "grunt rebuild" to compile new source and minified files to include in your PR.

grunt-closure-compiler requires the closure compiler jar file. The path is set in Gruntfile.js, but by default should exist in a directory called "closure" parallel to App Framework

```
-- appframework
-- closure
-- build
-- compiler.jar
```

# Pull Requests

Pull requests will not be considered without the following:

1. Explanation of the bug
2. Test case that proves the current code base is failing
3. Explanation of the fix

We will pull the code down and test it and then provide feedback. If everything passes, we will merge and rebuild the files.


# Bugs

Please use github issues and file any bugs with the following

1. Any error messages from the console

2. Line numbers of offending code

3. Test cases

4. Description of the error

5. Expected result

6. Browser/Device you are testing on


# License # License


App Framework is is licensed under the terms of the MIT License, see the included license.txt file. App Framework is is licensed under the terms of the MIT License, see the included license.txt file.
Expand Down

0 comments on commit 724d7e9

Please sign in to comment.