Skip to content

Commit

Permalink
Merge pull request #49 from alanxoc3/GH-6-two-inputs
Browse files Browse the repository at this point in the history
Backend refactor. Metafile change. 2 inputs. Better tests.
  • Loading branch information
alanxoc3 committed Sep 29, 2020
2 parents 6d79758 + dc4395e commit 127782f
Show file tree
Hide file tree
Showing 43 changed files with 2,021 additions and 1,359 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ script:
- echo Building Concards $CONCARDS_VERSION
- go get github.com/mattn/goveralls
- go test -v ./...
- "$GOPATH/bin/goveralls -service=travis-ci"
- "$GOPATH/bin/goveralls -service=travis-ci || true"

before_deploy:
- go get github.com/mitchellh/gox
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,23 @@ page](https://github.com/alanxoc3/concards/releases). At the moment, only Linux
and Mac are supported.

### Building From Source
Use the `go install` command, passing in snapshot as the version concards
compiles with.
It should be super simple. Just use the `go install` command:
``` bash
go install -ldflags="-X main.version=snapshot" github.com/alanxoc3/concards
go install github.com/alanxoc3/concards
```

### Dependencies
This project currently depends on:
- [stretchr/testify](https://github.com/stretchr/testify) for unit tests.
- [alanxoc3/argparse](https://github.com/alanxoc3/argparse) forked from
[akamensky/argparse](https://github.com/akamensky/argparse) for CLI options.
- [nsf/termbox-go](https://github.com/nsf/termbox-go) for the terminal gui.
- [mattn/go-runewidth](https://github.com/mattn/go-runewidth) to help with
Asian characters.

Concards wouldn't be where it is today without those open source projects &
their contributors, so please check them out too :).

## Usage
The complete syntax of embedding your flashcards into text documents consists
of these keywords:
Expand All @@ -59,7 +70,7 @@ Here are a few example concards:
can save typing.
@> Can a concard have more than 2 sides?
| Yes. | Yes it can.
| Yes
@> What does a concard look like?
| \@> It could look like this \| What does a concard look like? \<@
Expand Down
65 changes: 0 additions & 65 deletions core/algs.go

This file was deleted.

161 changes: 0 additions & 161 deletions core/card.go

This file was deleted.

Loading

0 comments on commit 127782f

Please sign in to comment.