Tidy up project with Makefile/README

.gitignore

@@ -22,3 +22,4 @@ _testmain.go
 *.exe
 
 archive_redditor*
+releases/

Makefile

@@ -0,0 +1,39 @@
+LDFLAGS = "-X main.Buildstamp=`date -u '+%Y-%m-%d_%I:%M:%S%p'` -X main.Githash=`git rev-parse HEAD`"
+SRC := $(shell find ./ -type f -regex ".*\.go")
+RELEASE_DIR = $(shell echo "releases/release_`git rev-parse HEAD`")
+
+all: archive_redditor
+
+release: target-darwin-amd64 target-linux-amd64 target-windows-amd64
+
+test:
+	go test -v .
+
+archive_redditor:
+	go build -v .
+
+install:
+	go install -v .
+
+target-darwin-amd64: $(SRC)
+	mkdir -p $(RELEASE_DIR)
+	GOOS=darwin GOARCH=amd64 go build -o archive_redditor -ldflags $(LDFLAGS) .
+	zip $(RELEASE_DIR)/archive_redditor_darwin_amd64.zip archive_redditor
+	rm -f archive_redditor
+
+target-linux-amd64: $(SRC)
+	mkdir -p $(RELEASE_DIR)
+	GOOS=linux GOARCH=amd64 go build -o archive_redditor -ldflags $(LDFLAGS) .
+	zip $(RELEASE_DIR)/archive_redditor_linux_amd64.zip archive_redditor
+	rm -f archive_redditor
+
+target-windows-amd64: $(SRC)
+	mkdir -p $(RELEASE_DIR)
+	GOOS=windows GOARCH=amd64 go build -o archive_redditor.exe -ldflags $(LDFLAGS) .
+	zip $(RELEASE_DIR)/archive_redditor_windows_amd64.zip archive_redditor.exe
+	rm -f archive_redditor.exe
+
+clean:
+	rm -rf archive_redditor archive_redditor.exe $(RELEASE_DIR)
+
+.PHONY: $(release) clean install test

README.md

@@ -0,0 +1,38 @@
+archive_redditor
+================
+
+A simple utility to archive a redditor's submissions to disk (for all of the really good NoSleep stories you don't want to become bookmarked 404s).
+
+## Installation
+
+To install from source, first, [Install Go](https://golang.org/doc/install), and then run:
+
+    go get github.com/l1na-forever/archive_redditor
+
+**Binary releases can be found on the [Releases page](https://github.com/l1na-forever/archive_redditor/releases/).**
+
+## Usage
+
+To archive a redditor's submissions, run the command:
+
+    archive_redditor <username> <output directory path>
+
+This will create the directory and populate it with text files of the following naming scheme:
+
+    <year><month><date>_<post ID>_<username>_<post title slug>.txt
+
+The contexts of the file will be the submission's selftext. Existing files won't be erased or overwritten.
+
+## Status
+
+Presently, the utility saves only selftext posts hosted on reddit.com. In the future, support may be added for archiving additional types of posts. Support may also be added for archiving off-site links (for example, archiving a user's images hosted off-site).
+
+## Licence
+
+Copyright © 2020 Lina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

code-of-conduct.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tylerneely@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+