Initial implementation
This commit is contained in:
18
README.md
18
README.md
@@ -35,4 +35,20 @@ From either the calendar grid or the timeline view, the user can click on a spec
|
||||
- The application is compiled into a single binary (plus a config file) for easy deployment.
|
||||
- Configuration is done via a config file that is read at startup.
|
||||
- The application can be run as a standalone server on a specified port.
|
||||
- Static files (CSS, JS, images) are inculeded in the binary using Go's embed package.
|
||||
- Static files (CSS, JS, images) are inculeded in the binary using Go's embed package.
|
||||
|
||||
## Building
|
||||
|
||||
To compile the application and create a runnable binary in the `bin` folder:
|
||||
|
||||
```bash
|
||||
go build -o bin/chronological ./cmd/chronological
|
||||
```
|
||||
|
||||
This will create the `chronological` executable in the `bin` directory. You can then run it with:
|
||||
|
||||
```bash
|
||||
./bin/chronological -config config.ini
|
||||
```
|
||||
|
||||
If no config file is specified, the application will look for `config.ini` in the current directory and use default settings if not found.
|
||||
Reference in New Issue
Block a user