Skip to content

Commit

Permalink
Update docs and readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcfarlane committed Apr 24, 2023
1 parent 295df39 commit 8e4df8d
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 9 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ docker-runnable: docker-build-export-target
iterate: all
./notable -db /tmp/notable-test.db -daemon=false -browser=false

lorem-ipsum:
cd cmd/lorem-ipsum && go run main.go

# target: Create the target directory
target:
mkdir target
Expand Down
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ You can view recent changes in the [changelog](CHANGELOG.md).
- [x] [Keybase](https://keybase.io/)
- [x] [Syncthing](https://syncthing.net/)
- [x] Autosave (note specific)
- [x] On demand re-indexing (useful for backup/restore)

## Installation

Expand All @@ -38,10 +39,10 @@ Download and extract the latest
The zip file contains an executable named `notable`. The MacOS version also
includes an [app bundle](https://en.wikipedia.org/wiki/Bundle_(macOS)).

### Compile from source (using latest dependencies)
### Install from source

```
go get -u github.com/jmcfarlane/notable
go install github.com/jmcfarlane/notable@latest
notable
```

Expand All @@ -51,17 +52,35 @@ Notable uses GNU Make and shell scripts for it's build. You can get
some detail on what the build supports by it's `help` target:

```
git clone https://github.com/jmcfarlane/notable.git
cd notable
make help
>> Help info for supported targets:
make all: Produce a binary suitable for local testing only
make build: Produce artifacts via scripts/build.sh (meant for OCI builds)
make clean: Purge the target directory
make coverage: Display code coverage in html
make docker-build-export-target: Perform an OCI build (and export the target dir)
make docker-build: Perform a docker build
make docker-runnable: Create a runnable docker container
make docker-run: Run the most recent runable docker container in the foreground
make help: Print help information
make install: Install using/into the active $GOPATH
make iterate: Build and run with a test db in the foreground
make prepare-release: Prepare all assets for release
make publish-release: Publish a release
make target: Create the target directory
make test: Run go test
make tidy: Tidy makes sure go.mod matches the source code in the module
make uninstall: Uninstall everything from this project
make vet: Run go vet
```

### Compile from source (using known good dependencies)

```
go get -u -d github.com/jmcfarlane/notable
cd $GOPATH/github.com/jmcfarlane/notable
make test vet
make
./notable
make iterate
```

### Run via a [Docker](https://www.docker.com/) container
Expand Down Expand Up @@ -112,17 +131,17 @@ focused).
| ------------------------------------------------------------- | ------------------------- |
| [Ace](https://ace.c9.io/) | Editor |
| [Backbone.js](http://backbonejs.org/) | Javascript framework |
| [Bleve](http://www.blevesearch.com/) | Full text search |
| [bboltDB](https://go.etcd.io/bbolt) | Datastore |
| [Bleve](http://www.blevesearch.com/) | Full text search |
| [Bootstrap](http://getbootstrap.com/) | User interface |
| [Chi](https://github.com/go-chi/chi) | HTTP Router |
| [errors](https://github.com/pkg/errors) | Golang error primatives |
| [go-homedir](https://github.com/mitchellh/go-homedir) | Home directory detection |
| [Golang](https://golang.org/) | Business logic |
| [httprouter](https://github.com/julienschmidt/httprouter) | Mux |
| [jQuery](https://jquery.com/) | Dom manipulation |
| [logrus](https://github.com/sirupsen/logrus) | Golang logging |
| [Mousetrap](https://craig.is/killing/mice) | Keyboard bindings |
| [Require.js](http://requirejs.org/) | Dependency management |
| [text plugin](http://github.com/requirejs/text) | Text templates |
| [Underscore.js](http://underscorejs.org/) | Client side templating |
| [uuid](https://github.com/twinj/uuid) | UUID implementation |
| [uuid](https://github.com/gofrs/uuid) | UUID implementation |
Binary file modified docs/images/edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/encrypted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/notable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tabs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/unsaved-changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8e4df8d

Please sign in to comment.