Skip to content

Commit e6d634b

Browse files
committed
Add an installation script and directions
1 parent a584939 commit e6d634b

File tree

2 files changed

+56
-2
lines changed

2 files changed

+56
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1-
# readthedocs-common
1+
Read the Docs common development files
2+
======================================
23

3-
Shared bits around multiple repositories
4+
Common shared bits for development and release tooling across multiple
5+
repositories.
6+
7+
Installing
8+
----------
9+
10+
To install::
11+
12+
git submodule add [email protected]:rtfd/common.git common
13+
git submodule update
14+
make -f common/common.mk

common.mk

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# ___ ___ ___ ___ ___ ___
2+
# /\ \ /\ \ /\__\ /\__\ /\ \ /\__\
3+
# /::\ \ /::\ \ /::| | /::| | /::\ \ /::| |
4+
# /:/\:\ \ /:/\:\ \ /:|:| | /:|:| | /:/\:\ \ /:|:| |
5+
# /:/ \:\ \ /:/ \:\ \ /:/|:|__|__ /:/|:|__|__ /:/ \:\ \ /:/|:| |__
6+
# /:/__/ \:\__\/:/__/ \:\__\/:/ |::::\__\/:/ |::::\__\/:/__/ \:\__\/:/ |:| /\__\
7+
# \:\ \ \/__/\:\ \ /:/ /\/__/~~/:/ /\/__/~~/:/ /\:\ \ /:/ /\/__|:|/:/ /
8+
# \:\ \ \:\ /:/ / /:/ / /:/ / \:\ /:/ / |:/:/ /
9+
# \:\ \ \:\/:/ / /:/ / /:/ / \:\/:/ / |::/ /
10+
# \:\__\ \::/ / /:/ / /:/ / \::/ / /:/ /
11+
# \/__/ \/__/ \/__/ \/__/ \/__/ \/__/
12+
#
13+
14+
# Default
15+
default: link pre-commit
16+
17+
# Config rules
18+
CONFIG = \
19+
prospector.yml
20+
21+
CONFIG_HIDDEN = \
22+
.eslintrc \
23+
.flake8 \
24+
.isort.cfg \
25+
.pep8 \
26+
.pre-commit-config.yaml \
27+
.style.yapf \
28+
29+
CONFIG_ALL = $(CONFIG) $(CONFIG_HIDDEN)
30+
31+
32+
.PHONY: link default pre-commit ignore
33+
34+
link: $(CONFIG_ALL)
35+
36+
$(CONFIG): %: common/%
37+
[ -e "$@" ] || (ln -s $? $@ && git add $@)
38+
39+
$(CONFIG_HIDDEN): .%: common/%
40+
[ -e "$@" ] || (ln -s $? $@ && git add $@)
41+
42+
pre-commit:
43+
pre-commit clean

0 commit comments

Comments
 (0)