Skip to content

Commit 470ccf0

Browse files
committed
docs: update README
1 parent 962e768 commit 470ccf0

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,25 @@ Staying organized in the easiest way possible.
66
*A tool for per-project timestamped work logging.*
77
The point is so that when your boss asks you seven months later why you made a very specific design decision, you can send them the whole list of progress updates on the project throughout its lifecycle.
88

9-
## Build Instructions
10-
11-
This project tracker can be built with `go build -o <outdir/executablefilename>`
12-
13-
where the output directory and executable name are provided after the `-o` flag.
14-
15-
ex.
9+
It backs up to a sqlite db which could easily be backed up.
1610

17-
`go build` - will create an executable named "project-management"
11+
## Build Instructions
1812

19-
you can execute the file by running `./project-management "my message"`
13+
If you're new to Go, check out ["How to Build and Install Go Programs"](https://www.digitalocean.com/community/tutorials/how-to-build-and-install-go-programs)
2014

2115
## Running the Program
2216
navigate to the root directory of the project and run either `go run .` to run the program or `go build` to build the program binary.
2317
If you built the binary, you can run it with `./project-management` or even add it to your PATH so you can just run `project-management` from anywhere.
2418

19+
## TODOs
20+
21+
- [ ] print to PDF
22+
- [ ] print to markdown
23+
- [ ] backup to `charm-fs`
24+
25+
### Entry View
26+
- [ ] hold entries in entry Model, convert that to string instead of all entries to a single string
27+
- [ ] look over fields, cut unnecessary ones
28+
2529
## Collaboration
2630
You're welcome to write features and report issues for this project.

0 commit comments

Comments
 (0)