archives/tweego
2
0
Fork 0
mirror of https://github.com/tmedwards/tweego.git synced 2025-07-04 13:47:03 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Update] Update README and .gitignore.

Browse source
This commit is contained in:
Thomas M. Edwards 2019-12-23 21:56:28 -06:00
parent 9ea2fabb84
commit 29570607dd
2 changed files with 15 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

26
.gitignore vendored
View file

@ -1,34 +1,32 @@
# Binaries for programs and plugins # Binaries
*.exe *.exe
*.exe~ *.exe~
*.dll *.dll
*.so *.so
*.dylib *.dylib
# Test binary, built with `go test -c`
*.test *.test
# Output of the go coverage tool, specifically when used with LiteIDE # Coverage tool (specifically when used with LiteIDE)
*.out *.out
# Shell scripts # Scripts
*.sh *.sh
# Dependency directories & files # Documentation
go.sum
# vendor/
# Documentation directories & files
*.html *.html
# Build & distribution directories # Dependencies
dist/ go.sum
# Testing directories & files # Builds & distribution
dist/
licenses/
# Testing
storyformats/ storyformats/
prerelease.go prerelease.go
# Miscellaneous directories & files # Miscellaneous
_* _*
CHANGELOG* CHANGELOG*
TODO* TODO*

6
README.md
View file

@ -4,7 +4,7 @@
See [Tweego's documentation](http://www.motoslave.net/tweego/docs/) for information on how to set it up and use it. See [Tweego's documentation](http://www.motoslave.net/tweego/docs/) for information on how to set it up and use it.
Tweego has a Trello board, [Tweego TODO](https://trello.com/b/l5xuRzFu). Feel free to comment. If you believe that you've found a bug in Tweego or simply wish to make a suggestion, you may do so by [creating a new issue](https://github.com/tmedwards/tweego/issues). Tweego also has a [work log](https://github.com/tmedwards/tweego/projects/1) that may be of interest.
## INSTALLATION ## INSTALLATION
@ -19,7 +19,7 @@ Tweego is written in the Go programming language, so you'll need to install it,
1. [Download and install the Go programming language (want ≥v1.13)](http://golang.org/doc/install) 1. [Download and install the Go programming language (want ≥v1.13)](http://golang.org/doc/install)
2. [Download and install the Git source control management tool](https://git-scm.com/) 2. [Download and install the Git source control management tool](https://git-scm.com/)
Once all the tooling is installed and set up, the next step is to fetch the Tweego source code. Open a shell to wherever you wish to store the code and run the following command: Once all the tooling is installed and set up, the next step is to fetch the Tweego source code. Open a shell to wherever you wish to store the code and run the following command to clone the repository:
``` ```
git clone https://github.com/tmedwards/tweego.git git clone https://github.com/tmedwards/tweego.git
@ -31,7 +31,7 @@ Next, change to the directory that the previous command created:
cd tweego cd tweego
``` ```
Next, fetch Tweego's dependencies via the following command: Next, fetch Tweego's dependencies:
``` ```
go get go get