jlengrand/RemarkablePocket
1
0
Fork 0
mirror of https://github.com/jlengrand/RemarkablePocket.git synced 2026-03-10 08:41:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add build instructions

Browse Source
This commit is contained in:
Robert Carosi
2021-11-14 16:34:39 +01:00
parent d5232e8f80
commit deb4d96bce
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -81,6 +81,15 @@ Synchronizes articles from Pocket to the Remarkable tablet.
- Articles on websites with sophisticated DDOS protection cannot be downloaded.
- Articles that use javascript to load the the content cannot be downloaded.
## Build Instructions
The project uses Gradle as a build tool and can be built using the `gradle build` command. This will generate jars in `build/libs/`. To run the jar, use the `java -jar build/libs/remarkable-pocket-x.x.x.jar` command, replacing `x.x.x` with the correct version.
### Building docker
To build the docker image run `gradle jib`. This will use a dynamically generated Dockerfile based on the configuration in the `jib` section of the `build.gradle` file. To run the image, see the command in the [Usage](#usage) section.
### Other package formats
If you would like to package the application in another format e.g. `deb`, `nix` or `AUR`, I'm happy to review a Pull Request.
## Thanks
- https://epub.press/ for providing a free epub generator API. Consider donating to support this project.
- https://github.com/jlarriba/jrmapi for providing a Java API for the Remarkable Cloud.