diff --git a/README.md b/README.md index d94abc07..f79ebad8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Zotero PDF/EPUB/HTML reader and annotator +# yeondoo-pdf -## Build +## How to Start +### Build Clone the repository: ``` -git clone https://github.com/zotero/reader --recursive +git clone https://github.com/coddingyun/yeondoo-pdf.git --recursive ``` With Node 18+, run the following: @@ -17,7 +18,11 @@ NODE_OPTIONS=--openssl-legacy-provider npm run build This will produce `dev`, `web` and `zotero` builds in the `build/` directory. -## Development +### Development +First, you need to run [YEONDOO-fe](https://github.com/YEONDOO-swm/YEONDOO-fe) -Run `npm start` and open http://localhost:3000/dev/reader.html. +Then, run `npm start` and open http://localhost:3000/dev/reader.html. + +## License +yeondoo-pdf is under GNU AFFERO GENERAL PUBLIC LICENSE. See the [LICENSE](https://github.com/coddingyun/yeondoo-pdf/blob/master/LICENSE) file for more info.