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/
|
||||
/.psc*
|
||||
/.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.
|
||||
|
||||
We also welcome documentation in the form of guides and examples. These should
|
||||
live in the [Documentation](Documentation) directory. Please ensure all guides
|
||||
are written in markdown format, and all examples are fully-functional and
|
||||
live in the [Documentation](docs) directory. Please ensure all guides are
|
||||
written in markdown format, and all examples are fully-functional and
|
||||
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
|
||||
examples we promote remain functional. If you plan to contribute examples,
|
||||
|
22
Makefile
22
Makefile
@ -14,18 +14,18 @@ NPM := npm
|
||||
BOWERJSON := bower.json
|
||||
|
||||
# Various input directories
|
||||
SRCPATH := ./Library
|
||||
TESTPATH := ./Test
|
||||
OUTPUT := ./Output
|
||||
DOCS := ./Documentation
|
||||
SRCPATH := ./src
|
||||
TESTPATH := ./test
|
||||
OUTPUT := ./out
|
||||
DOCS := ./docs
|
||||
EXAMPLESPATH := $(DOCS)/Examples
|
||||
EXAMPLEPATH := $(EXAMPLESPATH)/$(EXAMPLE)
|
||||
|
||||
# Various output directories
|
||||
BUILD := $(OUTPUT)/Build
|
||||
COMPONENTS := $(OUTPUT)/Components
|
||||
OUTPUT_DOCS := $(OUTPUT)/Documentation
|
||||
OUTPUT_EXAMPLE := $(OUTPUT)/Examples/$(EXAMPLE)
|
||||
BUILD := $(OUTPUT)/build
|
||||
COMPONENTS := $(OUTPUT)/components
|
||||
OUTPUT_DOCS := $(OUTPUT)/docs
|
||||
OUTPUT_EXAMPLE := $(OUTPUT)/examples/$(EXAMPLE)
|
||||
|
||||
# The entry point for the compiled example, if an EXAMPLE is specified
|
||||
EXAMPLE_INDEX := $(OUTPUT_EXAMPLE)/index.js
|
||||
@ -92,8 +92,7 @@ repl: $(COMPONENTS) $(SOURCES) $(TESTSOURCES) $(EXAMPLESOURCES)
|
||||
$(PULP) repl \
|
||||
--include $(EXAMPLESPATH) \
|
||||
--src-path $(SRCPATH) \
|
||||
--test-path $(TESTPATH) \
|
||||
-- --stash --censor-lib --strict
|
||||
--test-path $(TESTPATH)
|
||||
|
||||
# Remove all make output from the source tree
|
||||
clean:
|
||||
@ -115,8 +114,7 @@ help:
|
||||
# Build the documentation
|
||||
$(OUTPUT_DOCS): $(COMPONENTS) $(SOURCES)
|
||||
$(PULP) docs \
|
||||
--src-path $(SRCPATH) \
|
||||
-- --stash --censor-lib --strict
|
||||
--src-path $(SRCPATH)
|
||||
rm -rf $(OUTPUT_DOCS)
|
||||
mv generated-docs $(OUTPUT_DOCS)
|
||||
docs: $(OUTPUT_DOCS)
|
||||
|
@ -46,8 +46,8 @@ on [Pursuit](http://pursuit.purescript.org/packages/purescript-httpure).
|
||||
|
||||
## Examples
|
||||
|
||||
HTTPure ships with a number of [examples](Documentation/Examples). To run an
|
||||
example, in the project root, run:
|
||||
HTTPure ships with a number of [examples](docs/Examples). To run an example, in
|
||||
the project root, run:
|
||||
|
||||
```bash
|
||||
make example EXAMPLE=<Example Name>
|
||||
|
@ -9,9 +9,9 @@
|
||||
},
|
||||
"ignore": [
|
||||
"**/.*",
|
||||
"Documentation",
|
||||
"Output",
|
||||
"Test",
|
||||
"docs",
|
||||
"out",
|
||||
"test",
|
||||
"Makefile",
|
||||
"*.json",
|
||||
"*.md"
|
||||
|
Loading…
Reference in New Issue
Block a user