Update readme
This commit is contained in:
2
Makefile
2
Makefile
@@ -7,4 +7,4 @@ build:
|
|||||||
backgroundrun:
|
backgroundrun:
|
||||||
go run main.go
|
go run main.go
|
||||||
backgroundsvelte:
|
backgroundsvelte:
|
||||||
cd svelte && npm run dev
|
cd svelte && npm install && npm run dev
|
||||||
|
13
README.md
13
README.md
@@ -4,10 +4,10 @@ Web interface for pixeldrain.com
|
|||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
Install the package in your $GOPATH with this command:
|
Clone the repo:
|
||||||
|
|
||||||
```
|
```
|
||||||
go get fornaxian.tech/pixeldrain_web
|
git clone git@github.com:Fornaxian/pixeldrain_web.git
|
||||||
```
|
```
|
||||||
|
|
||||||
Enter the directory and run main.go with `go run main.go`. It will generate a
|
Enter the directory and run main.go with `go run main.go`. It will generate a
|
||||||
@@ -26,7 +26,8 @@ requests are proxied so files you view locally will not be counted.
|
|||||||
## Svelte
|
## Svelte
|
||||||
|
|
||||||
Most of the frontend uses Svelte. These Svelte files need to be compiled before
|
Most of the frontend uses Svelte. These Svelte files need to be compiled before
|
||||||
they can be used. The Makefile contains from help for this. Running `make run`
|
they can be used. The compiled svelte files are not in the repo so you need to
|
||||||
starts the dev server on :8081 and compiles and hot-reloads the Svelte
|
compile them yourself before you can use the development server. The Makefile
|
||||||
components in the background. To manually compile the Svelte files do `cd svelte
|
contains help for this. Running `make run` starts the dev server on :8081 and
|
||||||
&& npm run build`.
|
compiles and hot-reloads the Svelte components in the background. To manually
|
||||||
|
compile the Svelte files do `cd svelte && npm run build`.
|
||||||
|
Reference in New Issue
Block a user