From 8777050d3eddf3ca47417a3ed589f672c52a91f5 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Fri, 28 Jul 2017 14:34:15 +0100 Subject: [PATCH] Update README.md Former-commit-id: 22fba43b4459ee9f6b957a474ca20428778258cf [formerly c6ad29099fb71bd1674737ae84b7e50277cef3c9] [formerly 210afa8e9ed15d4fe59848cb773aad757173d513 [formerly 5c7a0b61d3bb8769d968a54786becf5f4107e3a8]] Former-commit-id: 0aff06fc85f31cf342989ba3c24562cff7a2b06c [formerly 0118f40e7c2ffb9c174df43ba24ef9b11f1f8977] Former-commit-id: ee823f96ce2ab93a91cd1e5456ee89687f95e100 --- README.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/README.md b/README.md index 79f57f41..551a5adf 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ filemanager provides a file managing interface within a specified directory and + [Features](#features) - [Users](#users) - [Search](#search) -+ [Contributing](#contributing) ++ [Contributing](https://github.com/hacdias/filemanager/blob/master/CONTRIBUTING.md) + [Donate](#donate) # 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 ``` -# 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 Enjoying this project? You can [donate to its creator](https://henriquedias.com/donate/). He will appreciate.