docs: update enviroment requirement
This commit is contained in:
30
README.md
30
README.md
@@ -1,14 +1,38 @@
|
|||||||
# Pathfinder
|
# Pathfinder
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Git
|
||||||
|
- Node: any 12.x version starting with v12.0.0 or greater
|
||||||
|
- Pnpm: See [how to installation](https://pnpm.io/installation)
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Open https://localhost:3000 in browser.
|
||||||
|
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
|
```
|
||||||
|
pnpm build
|
||||||
|
```
|
||||||
|
|
||||||
### Replace Modules
|
### Replace Modules
|
||||||
You can create `module-resolve.js` in project root dir to replace some package to better implements. Example:
|
|
||||||
|
You can create `module-resolve.js` in project root dir to replace some package to better implements.
|
||||||
|
|
||||||
|
There is a template file in `scripts/module-resolve/module-resolve.tmpl.js`.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
```
|
```
|
||||||
function resolve(pkg) {
|
function resolve(pkg) {
|
||||||
if (pkg.dependencies && pkg.dependencies['@toeverything/track']) {
|
if (pkg.dependencies && pkg.dependencies['@toeverything/pathfinder-logger']) {
|
||||||
pkg.dependencies['@toeverything/track'] = '^0.0.1';
|
pkg.dependencies['@toeverything/pathfinder-logger'] = '^0.0.1';
|
||||||
}
|
}
|
||||||
|
|
||||||
return pkg;
|
return pkg;
|
||||||
|
|||||||
Reference in New Issue
Block a user