Update README.md
This commit is contained in:
parent
9d9eaf03a3
commit
5c7a0b61d3
17
README.md
17
README.md
|
@ -16,7 +16,7 @@ filemanager provides a file managing interface within a specified directory and
|
||||||
+ [Features](#features)
|
+ [Features](#features)
|
||||||
- [Users](#users)
|
- [Users](#users)
|
||||||
- [Search](#search)
|
- [Search](#search)
|
||||||
+ [Contributing](#contributing)
|
+ [Contributing](https://github.com/hacdias/filemanager/blob/master/CONTRIBUTING.md)
|
||||||
+ [Donate](#donate)
|
+ [Donate](#donate)
|
||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
|
@ -179,21 +179,6 @@ By default, every search will be case sensitive. Although, you can make a case i
|
||||||
this are keywords case:insensitive
|
this are keywords case:insensitive
|
||||||
```
|
```
|
||||||
|
|
||||||
# Contributing
|
|
||||||
|
|
||||||
If you want to contribute or want to build the code from source, you will need to have the most recent version of Go and, if you want to change the static assets (JS, CSS, ...), Node.js installed on your computer. To start developing, you just need to do the following:
|
|
||||||
|
|
||||||
1. `go get github.com/hacdias/filemanager`
|
|
||||||
2. `cd $GOPATH/src/github.com/hacdias/filemanager`
|
|
||||||
3. `npm install`
|
|
||||||
4. `npm run dev` - regenerates the static assets automatically
|
|
||||||
5. `go install github.com/hacdias/filemanager/cmd/filemanager`
|
|
||||||
6. Execute `$GOPATH/bin/filemanager`
|
|
||||||
|
|
||||||
The steps 3 and 4 are only required **if you want to develop the front-end**. Otherwise, you can ignore them. Before pulling, if you made any change on assets folder, you must run the `build.sh` script on the root of this repository.
|
|
||||||
|
|
||||||
If you are using this as a Caddy plugin, you should use its [official instructions for plugins](https://github.com/mholt/caddy/wiki/Extending-Caddy#2-plug-in-your-plugin) and import `github.com/hacdias/filemanager/caddy/filemanager`.
|
|
||||||
|
|
||||||
# Donate
|
# Donate
|
||||||
|
|
||||||
Enjoying this project? You can [donate to its creator](https://henriquedias.com/donate/). He will appreciate.
|
Enjoying this project? You can [donate to its creator](https://henriquedias.com/donate/). He will appreciate.
|
||||||
|
|
Loading…
Reference in New Issue