diff --git a/README.md b/README.md index 8b1378917..a2d3624d8 100644 --- a/README.md +++ b/README.md @@ -1 +1,69 @@ +# LatexGo πŸ‘©β€πŸ’» +*When Latex meets JS = SuperFast builds* πŸ’ͺ + +## Description πŸ“– +A project inspired by the aim of improving the writing experience and make it easy for people to use the power of Latex. It is based on a simple concept of client-side compiling thus uses emscripten to convert the LLVM based Latex compiler to Javascript compiler, making it easy to compile and accessible to everyone for free. + +## Development πŸ—οΈ +1. Clone the repository. +2. Start a server inside the root directory (Look at [this](https://gist.github.com/jgravois/5e73b56fa7756fd00b89) if you need help with starting a server). +3. Open the browser and go to `http://localhost:{PORT}`. + + +### Checkout the current development version πŸ’ + +[LatexGo Website](https://latexgo.ipiyush.com) + +## Prerequisites to contribute πŸ‘‡ +It is desired to have a basic understanding of : +- LLVM compilers +- Emscripten +- Caching in browsers +- Typescript + +Required: +- Understanding and some experience in Nodejs + +And willingness to work!πŸ“™πŸ“•πŸ“— + +## Enhance your skillset πŸ’ͺ +Through this project you will learn: + +- WebSocket connections +- Syncing with Google Cloud +- About LLVM compilers +- Good Knowledge of Emscripten +- UI Designing skills + +### Ideas to work on πŸ™† + +1. Modularize the proof of concept +2. Improve lazy loading and caching +3. Implement Authorization, Live Collaboration, File Directry Management in the editor. + +## Let's get started ! πŸ‘πŸ» +We have made everything easy for you! πŸ‘ +Checkout [Contribute.md](contribute.md) to know how to contribute. + +## Project Admin πŸ‘¨ + +- [Piyush Agrawal](https://github.com/poush) + + +## Mentor πŸ‘¬ + +- [Aman Jain](https://github.com/jainaman224) + +Have any query? Feel free to ask! πŸ™‚ + +## License πŸ“ +Refer to [LICENSE](https://github.com/poush/LatexGo/blob/master/LICENSE). + +## Code of Conduct πŸ“ +Refer to [CODE_OF_CONDUCT](https://github.com/poush/LatexGo/blob/add/activeUsers/CODE_OF_CONDUCT.md). + +We are open to suggestions.If you've found a bug or want to suggest new features, you can create a [Github issue](https://github.com/poush/LatexGo/issues). + +Let’s grow together!! πŸ’›πŸ’™πŸ’›πŸ’™ +