Rename top level directories to be purescript standard
This commit is contained in:
parent
699cf18b13
commit
a2d81b8606
2
.bowerrc
2
.bowerrc
@ -1,3 +1,3 @@
|
|||||||
{
|
{
|
||||||
"directory": "Output/Components"
|
"directory": "out/components"
|
||||||
}
|
}
|
||||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,4 +1,4 @@
|
|||||||
/Output
|
/out
|
||||||
/.pulp-cache/
|
/.pulp-cache/
|
||||||
/.psc*
|
/.psc*
|
||||||
/.purs*
|
/.purs*
|
||||||
|
@ -39,10 +39,10 @@ this end, documentation should mostly be provided inline in the codebase, and
|
|||||||
should follow the same PR process as other commits.
|
should follow the same PR process as other commits.
|
||||||
|
|
||||||
We also welcome documentation in the form of guides and examples. These should
|
We also welcome documentation in the form of guides and examples. These should
|
||||||
live in the [Documentation](Documentation) directory. Please ensure all guides
|
live in the [Documentation](docs) directory. Please ensure all guides are
|
||||||
are written in markdown format, and all examples are fully-functional and
|
written in markdown format, and all examples are fully-functional and
|
||||||
implemented as self-contained subdirectories
|
implemented as self-contained subdirectories
|
||||||
under [Documentation/Examples](Documentation/Examples).
|
under [Documentation/Examples](docs/Examples).
|
||||||
|
|
||||||
All examples should have corresponding integration tests, to ensure that
|
All examples should have corresponding integration tests, to ensure that
|
||||||
examples we promote remain functional. If you plan to contribute examples,
|
examples we promote remain functional. If you plan to contribute examples,
|
||||||
|
22
Makefile
22
Makefile
@ -14,18 +14,18 @@ NPM := npm
|
|||||||
BOWERJSON := bower.json
|
BOWERJSON := bower.json
|
||||||
|
|
||||||
# Various input directories
|
# Various input directories
|
||||||
SRCPATH := ./Library
|
SRCPATH := ./src
|
||||||
TESTPATH := ./Test
|
TESTPATH := ./test
|
||||||
OUTPUT := ./Output
|
OUTPUT := ./out
|
||||||
DOCS := ./Documentation
|
DOCS := ./docs
|
||||||
EXAMPLESPATH := $(DOCS)/Examples
|
EXAMPLESPATH := $(DOCS)/Examples
|
||||||
EXAMPLEPATH := $(EXAMPLESPATH)/$(EXAMPLE)
|
EXAMPLEPATH := $(EXAMPLESPATH)/$(EXAMPLE)
|
||||||
|
|
||||||
# Various output directories
|
# Various output directories
|
||||||
BUILD := $(OUTPUT)/Build
|
BUILD := $(OUTPUT)/build
|
||||||
COMPONENTS := $(OUTPUT)/Components
|
COMPONENTS := $(OUTPUT)/components
|
||||||
OUTPUT_DOCS := $(OUTPUT)/Documentation
|
OUTPUT_DOCS := $(OUTPUT)/docs
|
||||||
OUTPUT_EXAMPLE := $(OUTPUT)/Examples/$(EXAMPLE)
|
OUTPUT_EXAMPLE := $(OUTPUT)/examples/$(EXAMPLE)
|
||||||
|
|
||||||
# The entry point for the compiled example, if an EXAMPLE is specified
|
# The entry point for the compiled example, if an EXAMPLE is specified
|
||||||
EXAMPLE_INDEX := $(OUTPUT_EXAMPLE)/index.js
|
EXAMPLE_INDEX := $(OUTPUT_EXAMPLE)/index.js
|
||||||
@ -92,8 +92,7 @@ repl: $(COMPONENTS) $(SOURCES) $(TESTSOURCES) $(EXAMPLESOURCES)
|
|||||||
$(PULP) repl \
|
$(PULP) repl \
|
||||||
--include $(EXAMPLESPATH) \
|
--include $(EXAMPLESPATH) \
|
||||||
--src-path $(SRCPATH) \
|
--src-path $(SRCPATH) \
|
||||||
--test-path $(TESTPATH) \
|
--test-path $(TESTPATH)
|
||||||
-- --stash --censor-lib --strict
|
|
||||||
|
|
||||||
# Remove all make output from the source tree
|
# Remove all make output from the source tree
|
||||||
clean:
|
clean:
|
||||||
@ -115,8 +114,7 @@ help:
|
|||||||
# Build the documentation
|
# Build the documentation
|
||||||
$(OUTPUT_DOCS): $(COMPONENTS) $(SOURCES)
|
$(OUTPUT_DOCS): $(COMPONENTS) $(SOURCES)
|
||||||
$(PULP) docs \
|
$(PULP) docs \
|
||||||
--src-path $(SRCPATH) \
|
--src-path $(SRCPATH)
|
||||||
-- --stash --censor-lib --strict
|
|
||||||
rm -rf $(OUTPUT_DOCS)
|
rm -rf $(OUTPUT_DOCS)
|
||||||
mv generated-docs $(OUTPUT_DOCS)
|
mv generated-docs $(OUTPUT_DOCS)
|
||||||
docs: $(OUTPUT_DOCS)
|
docs: $(OUTPUT_DOCS)
|
||||||
|
@ -46,8 +46,8 @@ on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
HTTPure ships with a number of [examples](Documentation/Examples). To run an
|
HTTPure ships with a number of [examples](docs/Examples). To run an example, in
|
||||||
example, in the project root, run:
|
the project root, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make example EXAMPLE=<Example Name>
|
make example EXAMPLE=<Example Name>
|
||||||
|
@ -9,9 +9,9 @@
|
|||||||
},
|
},
|
||||||
"ignore": [
|
"ignore": [
|
||||||
"**/.*",
|
"**/.*",
|
||||||
"Documentation",
|
"docs",
|
||||||
"Output",
|
"out",
|
||||||
"Test",
|
"test",
|
||||||
"Makefile",
|
"Makefile",
|
||||||
"*.json",
|
"*.json",
|
||||||
"*.md"
|
"*.md"
|
||||||
|
Loading…
Reference in New Issue
Block a user