overleaf/services/web/README.md

48 lines
1.6 KiB
Markdown
Raw Normal View History

web-sharelatex
==============
web-sharelatex is the front-end web service of the open-source web-based collaborative LaTeX editor,
2014-02-18 16:15:30 +00:00
[ShareLaTeX](https://www.sharelatex.com).
It serves all the HTML pages, CSS and javascript to the client. web-sharelatex also contains
a lot of logic around creating and editing projects, and account management.
The rest of the ShareLaTeX stack, along with information about contributing can be found in the
[sharelatex/sharelatex](https://github.com/sharelatex/sharelatex) repository.
2014-02-24 14:14:09 +00:00
Unit test status
----------------
[![Unit test status](https://travis-ci.org/sharelatex/web-sharelatex.png?branch=master)](https://travis-ci.org/sharelatex/web-sharelatex)
License and Credits
-------------------
### Code
2014-02-18 16:15:30 +00:00
All coffeescript files (files ended in *.coffee) are licensed under the
[AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.html).
### Stylesheets
ShareLaTeX is based on [Bootstrap](http://getbootstrap.com/), which is licensed under the
[MIT license](http://opensource.org/licenses/MIT).
All modifications (`*.less` files in `public/stylesheets`) are also licensed
under the MIT license.
2014-02-13 18:19:51 +00:00
### Artwork
#### Silk icon set 1.3
We gratefully acknowledge [Mark James](http://www.famfamfam.com/lab/icons/silk/) for
releasing his Silk icon set under the Creative Commons Attribution 2.5 license. Some
2014-02-18 16:15:30 +00:00
of these icons are used within ShareLaTeX inside the `public/img/silk` and
`public/brand/icons` directories.
2014-02-13 18:19:51 +00:00
#### IconShock icons
We gratefully acknowledge [IconShock](http://www.iconshock.com) for use of the icons
in the `public/img/iconshock` directory found via
[findicons.com](http://findicons.com/icon/498089/height?id=526085#)