cha0s/flecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: doc

Browse Source
This commit is contained in:
cha0s 2022-03-09 14:48:19 -06:00
parent 31238b18da
commit 8c2c7c653a
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -84,7 +84,7 @@ Flecks applications contain a `build` directory with a `flecks.yml` that defines
Flecks strives to provide powerful defaults that minimize the need to override configuration. Flecks strives to provide powerful defaults that minimize the need to override configuration.
[Learn more about the build directory](packages/core/build/dox/build.md). [Learn more about the build directory](packages/core/build/dox/concepts/build.md).
The simplest example of a flecks server application: The simplest example of a flecks server application:

6
packages/core/build/dox/build.md → packages/core/build/dox/concepts/build.md
View File

@ -5,6 +5,9 @@ The `build` directory is where build-time configuration is specified.
The prime example of this for Flecks is `flecks.yml`, but it extends to other more general The prime example of this for Flecks is `flecks.yml`, but it extends to other more general
configuration such as `.eslintrc.js`, `babel.config.js`, etc. configuration such as `.eslintrc.js`, `babel.config.js`, etc.
For a list of all build configuration, see the
[build configuration page](https://github.com/cha0s/flecks/blob/gh-pages/build-configs.md)
## `flecks.yml` ⛏️ ## `flecks.yml` ⛏️
`flecks.yml` specifies the flecks that compose your project. `flecks.yml` specifies the flecks that compose your project.
@ -30,6 +33,9 @@ ID to, say, `'example'`, would look like this:
'@flecks/fleck': {} '@flecks/fleck': {}
``` ```
See [the generated configuration page](https://github.com/cha0s/flecks/blob/gh-pages/config.md)
for a list of all configuration.
### Aliasing 🕵️‍♂️ ### Aliasing 🕵️‍♂️
Flecks may be aliased to alternative paths. Flecks may be aliased to alternative paths.