Add documentation for fsplc command

This commit is contained in:
Sasha Koshka 2024-02-09 03:22:36 -05:00
parent 0832a948bf
commit e49fc397d3
1 changed files with 21 additions and 0 deletions

21
cmd/fsplc/doc.go Normal file
View File

@ -0,0 +1,21 @@
// FSPLC compiles FSPL programs.
//
// Its job is to take in FSPL code, and compile it to one of the supported
// output formats. Currently it supports native object files, native ASM, and
// LLVM IR code.
//
// Usage:
// fsplc [OPTION]... [FILE]...
//
// -O=0
// Optimization level, 0-3. This does not have an effect when outputting
// LLVM IR code.
// -o=FILE.o
// The file to output to. The file extension determines what output format
// to use:
// - .o: Native object file
// - .s: Native assembly
// - .ll: LLVM IR code
// If unspecified, the name (without the extension) of the first input file
// is used, and a .o extension is added to produce an object file.
package main