diff --git a/Makefile b/Makefile index 6904f7c..e5dbd79 100644 --- a/Makefile +++ b/Makefile @@ -6,16 +6,23 @@ COMMANDS = cli/enry MAKEFILE = Makefile.main CI_REPOSITORY = https://github.com/src-d/ci.git CI_FOLDER = .ci - -# If you need to build more than one dockerfile, you can do so like this: -# DOCKERFILES = Dockerfile_filename1:repositoryname1 Dockerfile_filename2:repositoryname2 ... - $(MAKEFILE): @git clone --quiet $(CI_REPOSITORY) $(CI_FOLDER); \ cp $(CI_FOLDER)/$(MAKEFILE) .; - -include $(MAKEFILE) +# Docsrv: configure the languages whose api-doc can be auto generated +LANGUAGES = go +# Docsrv: configure the directory containing the python sources +PYTHON_MAIN_DIR ?= ./python +# Docs: do not edit this +DOCS_REPOSITORY := https://github.com/src-d/docs +SHARED_PATH ?= $(shell pwd)/.shared +DOCS_PATH ?= $(SHARED_PATH)/.docs +$(DOCS_PATH)/Makefile.inc: + git clone --quiet --depth 1 $(DOCS_REPOSITORY) $(DOCS_PATH); +-include $(DOCS_PATH)/Makefile.inc + LINGUIST_PATH = .linguist # build CLI diff --git a/README.md b/README.md index c3b09eb..ef38305 100644 --- a/README.md +++ b/README.md @@ -120,7 +120,7 @@ Note that even if enry's CLI is compatible with linguist's, its main point is th Java bindings ------------ -Generated Java binidings using a C shared library + JNI are located under [`java`](java) +Generated Java binidings using a C shared library + JNI are located under [`java`](https://github.com/src-d/enry/blob/master/java) Development ------------ @@ -141,7 +141,7 @@ So we update the generated code as needed, without any specific criteria. If you want to update *enry* because of changes in linguist, you can run the *go generate* command and do a pull request that only contains the changes in -generated files (those files in the subdirectory [data](data)). +generated files (those files in the subdirectory [data](https://github.com/src-d/enry/blob/master/data)). To run the tests, @@ -185,7 +185,7 @@ We found some few cases where enry turns slower than linguist. This is due to Golang's regexp engine being slower than Ruby's, which uses the [oniguruma](https://github.com/kkos/oniguruma) library, written in C. You can find scripts and additional information (like software and hardware used -and benchmarks' results per sample file) in [*benchmarks*](benchmarks) directory. +and benchmarks' results per sample file) in [*benchmarks*](https://github.com/src-d/enry/blob/master/benchmarks) directory. If you want to reproduce the same benchmarks you can run: