mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-21 20:47:08 -05:00
README beautification (#640)
This commit is contained in:
Miguel Serrano
GitHub
parent
2576675662
commit
0206c39082
3 changed files with 40 additions and 68 deletions
108
README.md
108
README.md
|
|
@ -1,96 +1,68 @@
|
|||
Overleaf
|
||||
========
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<a href="https://www.overleaf.com"><img src="doc/logo.png" alt="Overleaf" width="300"></a>
|
||||
</h1>
|
||||
|
||||
<h4 align="center">An open-source online real-time collaborative LaTeX editor.</h4>
|
||||
|
||||
<p align="center">
|
||||
<a href="#key-features">Key Features</a> •
|
||||
<a href="https://github.com/overleaf/overleaf/wiki">Wiki</a> •
|
||||
<a href="https://www.sharelatex.com/i/university/onsite">Server Pro</a> •
|
||||
<a href="#contributing">Contributing</a> •
|
||||
<a href="https://www.overleaf.com/for/enterprises">Mailing List</a> •
|
||||
<a href="#authors">Authors</a> •
|
||||
<a href="#license">License</a>
|
||||
</p>
|
||||
|
||||
<a href="https://www.overleaf.com"><img src="doc/screenshot.png" alt="Overleaf" ></a>
|
||||
|
||||
## Key Features
|
||||
|
||||
[Overleaf](https://www.overleaf.com) is an open-source online real-time collaborative LaTeX editor. We run a hosted version at http://www.overleaf.com, but you can also run your own local version, and contribute to the development of Overleaf.
|
||||
|
||||
*[If you want help installing and maintaining Overleaf at your university or workplace, we offer an officially supported version called Overleaf Server Pro. It also comes with extra security and admin features. Click here to find out more!](https://www.overleaf.com/university/onsite.html)*
|
||||
|
||||
Keeping up to date
|
||||
------------
|
||||
## Keeping up to date
|
||||
|
||||
Sign up to the [mailing list](https://mailchi.mp/overleaf.com/community-edition-and-server-pro) to get updates on Overleaf Releases and development
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
We have detailed installation instructions in our wiki:
|
||||
|
||||
* [Overleaf Quick Start Guide](https://github.com/overleaf/overleaf/wiki/Quick-Start-Guide)
|
||||
|
||||
|
||||
Upgrading
|
||||
---------
|
||||
## Upgrading
|
||||
|
||||
If you are upgrading from a previous version of Overleaf, please see the [Release Notes section on the Wiki](https://github.com/overleaf/overleaf/wiki/Home) for all of the versions between your current version and the version you are upgrading to.
|
||||
|
||||
|
||||
Other repositories
|
||||
------------------
|
||||
## Other repositories
|
||||
|
||||
This repository does not contain any code. It acts a wrapper and toolkit for managing the many different Overleaf services. These each run as their own Node.js process and have their own Github repository. These are all downloaded and set up when you run `grunt install`
|
||||
|
||||
The different services are:
|
||||
| Service | Description |
|
||||
| ------- | ----------- |
|
||||
| **[web](https://github.com/overleaf/web)** | The front facing web server that serves all the HTML pages, CSS and JavaScript to the client. Also contains a lot of logic around creating and editing projects, and account management. |
|
||||
| **[document-updater](https://github.com/overleaf/document-updater)** | Processes updates that come in from the editor when users modify documents. Ensures that the updates are applied in the right order, and that only one operation is modifying the document at a time. Also caches the documents in redis for very fast but persistent modifications. |
|
||||
| **[CLSI](https://github.com/overleaf/clsi)** | The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX documents. |
|
||||
| **[docstore](https://github.com/overleaf/docstore)** | An API for performing CRUD (Create, Read, Update and Delete) operations on text files stored in Overleaf. |
|
||||
| **[real-time](https://github.com/overleaf/real-time)** | The websocket process clients connect to. |
|
||||
| **[filestore](https://github.com/overleaf/filestore)** | An API for performing CRUD (Create, Read, Update and Delete) operations on binary files (like images) stored in Overleaf. |
|
||||
| **[track-changes](https://github.com/overleaf/track-changes)** | An API for compressing and storing the updates applied to a document, and then rendering a diff of the changes between any two time points. |
|
||||
| **[chat](https://github.com/overleaf/chat)** | The backend API for storing and fetching chat messages. |
|
||||
| **[tags](https://github.com/overleaf/tags)** | The backend API for managing project tags (folders). |
|
||||
| **[spelling](https://github.com/overleaf/spelling)** | An API for running server-side spelling checking on Overleaf documents. |
|
||||
|
||||
### [web](https://github.com/overleaf/web)
|
||||
|
||||
The front facing web server that serves all the HTML pages, CSS and JavaScript
|
||||
to the client. Also contains a lot of logic around creating and editing
|
||||
projects, and account management.
|
||||
|
||||
### [document-updater](https://github.com/overleaf/document-updater)
|
||||
|
||||
Processes updates that come in from the editor when users modify documents. Ensures that
|
||||
the updates are applied in the right order, and that only one operation is modifying
|
||||
the document at a time. Also caches the documents in redis for very fast but persistent
|
||||
modifications.
|
||||
|
||||
### [CLSI](https://github.com/overleaf/clsi)
|
||||
|
||||
The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX
|
||||
documents.
|
||||
|
||||
### [docstore](https://github.com/overleaf/docstore)
|
||||
|
||||
An API for performing CRUD (Create, Read, Update and Delete) operations on text files
|
||||
stored in Overleaf.
|
||||
|
||||
### [realtime](https://github.com/overleaf/real-time)
|
||||
|
||||
The websocket process clients connect to
|
||||
|
||||
### [filestore](https://github.com/overleaf/filestore)
|
||||
|
||||
An API for performing CRUD (Create, Read, Update and Delete) operations on binary files
|
||||
(like images) stored in Overleaf.
|
||||
|
||||
### [track-changes](https://github.com/overleaf/track-changes)
|
||||
|
||||
An API for compressing and storing the updates applied to a document, and then rendering a diff of the changes
|
||||
between any two time points.
|
||||
|
||||
### [chat](https://github.com/overleaf/chat)
|
||||
|
||||
The backend API for storing and fetching chat messages.
|
||||
|
||||
### [tags](https://github.com/overleaf/tags)
|
||||
|
||||
The backend API for managing project tags (folders).
|
||||
|
||||
### [spelling](https://github.com/overleaf/spelling)
|
||||
|
||||
An API for running server-side spelling checking on Overleaf documents.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
## Contributing
|
||||
|
||||
Please see the [CONTRIBUTING](https://github.com/overleaf/overleaf/blob/master/CONTRIBUTING.md) file for information on contributing to the development of Overleaf. See [our wiki](https://github.com/overleaf/overleaf/wiki/Developer-Guidelines) for information on setting up a development environment and how to recompile and run Overleaf after modifications.
|
||||
|
||||
Authors
|
||||
---
|
||||
## Authors
|
||||
|
||||
[The Overleaf Team](https://www.overleaf.com/about)
|
||||
|
||||
License
|
||||
----
|
||||
## License
|
||||
|
||||
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the `LICENSE` file.
|
||||
|
||||
|
|
|
|||
BIN
doc/logo.png
Normal file
BIN
doc/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
BIN
doc/screenshot.png
Normal file
BIN
doc/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 739 KiB |
Loading…
Reference in a new issue