From d8aa149a6bab81136d1302758abb7fefd4958334 Mon Sep 17 00:00:00 2001 From: asdfasdf Date: Sun, 15 Sep 2019 19:59:35 -0700 Subject: [PATCH] Added README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e161ff2 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# CPSC210 Personal Project: J-WatchList +Author: Benny Leung +## Description +J-WatchList is a simple stock market watch list tracker. + +## Dependencies +Build deps: +- gradle + +## Compiling from source +### .class +In a terminal: +``` +git clone https://github.students.cs.ubc.ca/cpsc210-2019w-t1/project_h9u2b +cd project_h9u2b +gradle clean build test checkstyleMain +``` + +Class files are in build/classes, to run with plain java: +``` +cd project_h9u2b +java -cp build/classes/java/main/:build/classes/java/main/ui ui.Iface +``` + +## Tags +To use tags, you will need ctags with the `-R` option. +`Exuberant Ctags` is recommended. +Rebuild tags with: +``` +gradle tags +``` +