Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update dev intructions in README.md #182

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

update dev intructions in README.md #182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Openbooks allows you to download ebooks from irc.irchighway.net quickly and easi
<img alt="openbooks screenshot" src="./.github/home_v3.png">
</picture>


## Getting Started

### Binary
Expand Down Expand Up @@ -46,13 +45,13 @@ two modes; Server or CLI. In CLI mode you interact and download books through
a terminal interface. In server mode the application runs as a web application
that you can visit in your browser.

Double clicking the executable will open the UI in your browser. In the future it may use [webviews](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) to provide a "native-like" desktop application.
Double clicking the executable will open the UI in your browser. In the future it may use [webviews](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) to provide a "native-like" desktop application.

## Development

### Install the dependencies

- `go get`
- `go mod tidy`
- `cd server/app && npm install`
- `cd ../..`
- `go run main.go`
Expand All @@ -79,14 +78,14 @@ Double clicking the executable will open the UI in your browser. In the future i
```

### Desktop App

Compile OpenBooks with experimental webview support:

``` shell
```shell
cd cmd/openbooks
go build -tags webview
```


## Why / How

- I wrote this as an easier way to search and download books from irchighway.net. It handles all the extraction and data processing for you. You just have to click the book you want. Hopefully you find it much easier than the IRC interface.
Expand Down