Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #178

Merged
merged 2 commits into from
Dec 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ asd [options] [alpsFile]
--and-tag={tag1, tag2} --or-tag={tag3} [--color=red]
Filter graph

-l, --label={id|title|both}
Displayed words

-m, --mode={markdown|html}
Output format

--port
Port number used in watch mode
```

* Supports XML and JSON formats.
Expand Down Expand Up @@ -160,6 +160,14 @@ ASD uses an XML config file (by default, asd.xml). A barebones example looks lik
You can start ASD development server with watch mode.
Each time the profile file changes, the page is reloaded.

If you want to start with a specific port number, you can specify the port number at startup as follows.

```xml
<asd>
<port>3001</port>
</asd>
```

### filter

```xml
Expand All @@ -177,14 +185,6 @@ You can extract partial graphs by specific tags, or color specific graphs.

Specify a tag name in the "or" or "and" field to specify the condition. If you specify "color", the graph for that condition will be colored, but if you don't, only the graph for that condition will be extracted and drawn.

### label

```xml
<asd>
<label>[string]</label>
</asd>
```

### markdown format

If your repository is private and your account is not a GHE or GHE Cloud account, you cannot make GitHub Pqges private. In such a case, you can output the document as Markdown and make the document private.
Expand Down
2 changes: 1 addition & 1 deletion bin/asd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ usage: asd [options] alps_file
EOT;
exit(0);
}
$options = getopt('c:w::l::m::', ['config:', 'watch::', 'color::', 'and-tag::', 'or-tag::', 'label::', 'mode::', 'port::']);
$options = getopt('c:w::m::', ['config:', 'watch::', 'color::', 'and-tag::', 'or-tag::', 'mode::', 'port::']);
if ($argc === 1) {
$options['c'] = getcwd();
}
Expand Down