Updated README and usage message to reflect filename change
This commit is contained in:
parent
a0da416f88
commit
8aa47d3af0
14
README.md
14
README.md
|
@ -91,9 +91,14 @@ Respond with a JSON object containing:
|
|||
|
||||
### Output Format
|
||||
|
||||
The system generates two types of output:
|
||||
The system generates dated output files when using arXiv queries:
|
||||
|
||||
1. **papers.json**: Raw paper data in JSON format (when fetching from arXiv)
|
||||
1. **`YYYYMMDD-YYYYMMDD-CATEGORY-papers.json`**: Raw arXiv results
|
||||
2. **`YYYYMMDD-YYYYMMDD-CATEGORY-papers.md`**: Final filtered results
|
||||
|
||||
When using `--input-json`, specify output name with `--output`.
|
||||
|
||||
Example files:
|
||||
```json
|
||||
[
|
||||
{
|
||||
|
@ -105,7 +110,10 @@ The system generates two types of output:
|
|||
]
|
||||
```
|
||||
|
||||
2. **papers.md**: Formatted markdown with accepted/rejected papers
|
||||
```markdown
|
||||
# Accepted Papers
|
||||
...
|
||||
```
|
||||
```markdown
|
||||
# Accepted Papers
|
||||
|
||||
|
|
7
main.go
7
main.go
|
@ -31,15 +31,16 @@ func main() {
|
|||
fmt.Fprintf(os.Stderr, " Input JSON flag:\n")
|
||||
fmt.Fprintf(os.Stderr, " -input-json string\n\tPath to input JSON file (bypasses arXiv fetch)\n\n")
|
||||
fmt.Fprintf(os.Stderr, "Optional flags:\n")
|
||||
fmt.Fprintf(os.Stderr, " -output string\n\tOutput markdown file path (default: papers.md)\n")
|
||||
fmt.Fprintf(os.Stderr, " -output string\n\tOutput markdown file path (default: papers.md or auto-dated format when using arXiv query)\n")
|
||||
fmt.Fprintf(os.Stderr, " -model string\n\tLLM model to use (default: nvidia/llama-3.1-nemotron-70b-instruct)\n\n")
|
||||
fmt.Fprintf(os.Stderr, "Environment variables:\n")
|
||||
fmt.Fprintf(os.Stderr, " OPENROUTER_API_KEY\tRequired for LLM processing\n\n")
|
||||
fmt.Fprintf(os.Stderr, "Examples:\n")
|
||||
fmt.Fprintf(os.Stderr, " Fetch from arXiv:\n")
|
||||
fmt.Fprintf(os.Stderr, " %s -start 20240101 -end 20240131 -search cs.AI -criteria criteria.txt -output papers.md\n\n", os.Args[0])
|
||||
fmt.Fprintf(os.Stderr, " %s -start 20240101 -end 20240131 -search cs.AI -criteria criteria.txt\n", os.Args[0])
|
||||
fmt.Fprintf(os.Stderr, " (Outputs: 20240101-20240131-cs.AI-papers.md)\n\n")
|
||||
fmt.Fprintf(os.Stderr, " Use existing JSON:\n")
|
||||
fmt.Fprintf(os.Stderr, " %s -input-json papers.json -criteria new-criteria.txt -output results.md\n", os.Args[0])
|
||||
fmt.Fprintf(os.Stderr, " %s -input-json papers.json -criteria new-criteria.txt -output custom-name.md\n", os.Args[0])
|
||||
}
|
||||
|
||||
// CLI flags
|
||||
|
|
Loading…
Reference in New Issue