How to build Lychee
This commit is contained in:
parent
0c4f23108e
commit
faf230a96f
20
docs/md/Build.md
Normal file
20
docs/md/Build.md
Normal file
@ -0,0 +1,20 @@
|
||||
### Dependencies
|
||||
|
||||
First you have to install the following dependencies:
|
||||
|
||||
- [CSS Optimizer](https://github.com/css/csso) `csso`
|
||||
- [UglifyJS](https://github.com/mishoo/UglifyJS2) `uglifyjs`
|
||||
|
||||
These dependencies can be installed using `npm`:
|
||||
|
||||
npm install csso uglify-js -g;
|
||||
|
||||
### Build
|
||||
|
||||
The Makefile is located in `docs/` and can be easily executed, using the following command. Make sure your run this from the root of Lychee:
|
||||
|
||||
make -f docs/Makefile
|
||||
|
||||
### Use uncompressed files
|
||||
|
||||
While developing, you might want to use the uncompressed files. This is possible by editing the `index.html`. Simply change the linked CSS and JS files. There are already out-commented link-tags for development and production.
|
@ -23,6 +23,10 @@ Sign in and click the gear on the top left corner to change your settings. If yo
|
||||
|
||||
Updating is as easy as it should be. [Update »](docs/md/Update.md)
|
||||
|
||||
### Build
|
||||
|
||||
Lychee is ready to use, right out of the box. If you want to contribute and edit CSS or JS files, you need to rebuild Lychee. [Build »](docs/md/Build.md)
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
These shortcuts will help you to use Lychee even faster. [Keyboard Shortcuts »](docs/md/Keyboard Shortcuts.md)
|
||||
|
Loading…
Reference in New Issue
Block a user