mirror of
https://github.com/fazo96/pbs.git
synced 2025-01-29 14:54:18 +01:00
updated readme
This commit is contained in:
parent
6b5f5f504d
commit
c768f74c39
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,4 +1,5 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
client/pert-ui.js
|
||||||
client/bower_components/
|
client/bower_components/
|
||||||
test/
|
test/
|
||||||
lib/
|
lib/
|
||||||
|
16
README.md
16
README.md
@ -8,8 +8,10 @@ Make sure you have `node` and `npm` installed and working
|
|||||||
|
|
||||||
__From git__
|
__From git__
|
||||||
|
|
||||||
1. clone this repo and run `build.sh`
|
1. clone this repo
|
||||||
2. run `bin/pert`
|
2. run `npm install` in the root of the repo, then run `bower install` in `client/` if you need to use the Web GUI
|
||||||
|
3. run `npm run-script build` to compile all files
|
||||||
|
4. the binary should now be in `bin/pert`
|
||||||
|
|
||||||
__From npm__
|
__From npm__
|
||||||
|
|
||||||
@ -18,18 +20,22 @@ __From npm__
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Usage: pert loads activity data from JSON and computes the possible activity delays
|
Usage: pert <command> [options] [args]
|
||||||
|
|
||||||
|
loads activity data from JSON and computes the possible activity delays
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
|
|
||||||
example show an example of the JSON data format
|
example show an example of the JSON data format
|
||||||
calculate|c [options] <file> calculate data on given JSON document
|
calculate|c [options] <file> calculate data on given JSON document
|
||||||
|
graph|g <file> serve HTTP GUI with pert graph of given JSON document
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
-h, --help output usage information
|
-h, --help output usage information
|
||||||
-V, --version output the version number
|
-V, --version output the version number
|
||||||
--verbose be verbose (for debugging)
|
-v, --verbose be verbose (for debugging)
|
||||||
|
|
||||||
|
|
||||||
This is the help information for the `pert calculate` command:
|
This is the help information for the `pert calculate` command:
|
||||||
|
|
||||||
@ -44,7 +50,7 @@ This is the help information for the `pert calculate` command:
|
|||||||
|
|
||||||
## Data format
|
## Data format
|
||||||
|
|
||||||
This is a valid input document:
|
This is a valid input document (extra data is ignored but not thrashed):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
|
@ -9,8 +9,9 @@ ex = [{id: 0, depends: [], duration: 2}, { id: 1, depends: [0], duration: 3},{id
|
|||||||
|
|
||||||
cli
|
cli
|
||||||
.version '0.1'
|
.version '0.1'
|
||||||
.usage 'loads activity data from JSON and computes the possible activity delays'
|
.description 'loads activity data from JSON and computes the possible activity delays'
|
||||||
.option '--verbose', 'be verbose (for debugging)'
|
.usage '<command> [options] [args]'
|
||||||
|
.option '-v, --verbose', 'be verbose (for debugging)'
|
||||||
|
|
||||||
didSomething = no
|
didSomething = no
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user